Copy page

Getting Started

Quickstart

From credentials to a registered domain in one guided path.

1. Obtain credentials

Contact your ResellerClub account manager or use your reseller control panel to obtain your API key credentials (user ID and API key).

2. Choose API environment and authorize

Click Authorize in the top bar.

• Sandbox or Live, choose the environment from the API environment dropdown. Sandbox is selected by default.
• Enter your user ID and API key once. All examples and playground requests use the selected base URL.

3. Domain registration journey

This walkthrough registers one domain end to end: check availability, create a customer and contact, register the domain, poll until the action completes, then update nameservers.

Base URL (follows your Authorize selection): https://api.sandbox.resellerclub.com/v2

Replace YOUR_* placeholders in each curl example with values from the previous step before running the next request.

Step	Time	What you'll do	Playground
4	2 min	Check if a domain name is available	Check domain availability
5	3 min	Create a customer account	Create a customer account
6	2 min	Create one contact (reused for all roles)	Create a contact
7	5 min	Register the domain	Register a new domain
8	2 min	Poll action status by order ID	Search current actions
9	2 min	Point the domain at new nameservers	Update domain nameservers

Sandbox note: Registration is a paid write operation. Use a funded reseller test account and a cheap, available TLD. If a step returns 403 Forbidden, check billing eligibility and API key scopes — the code field in the response body distinguishes scope errors from account eligibility issues.

4. Check availability

Confirm your chosen name is available before creating a customer.

Try in playground: Check domain availability

Look for an available result for your domain name. If the name is taken, change mybrand-test-12345 in the curl above and try again.

5. Create a customer

Every domain order is tied to a customer account.

Try in playground: Create a customer account

Save from response: copy customerId — you will paste it into the next curl as YOUR_CUSTOMER_ID.

Example response:

Code
{
  "customerId": "12345678",
  "status": "Success"
}

6. Create a contact

Domain registration requires registrant, admin, technical, and billing contacts. For this quickstart, create one contact and reuse its ID for all four roles in the register call.

Try in playground: Create a contact

Replace YOUR_CUSTOMER_ID with the customerId from step 5.

Save from response: copy contactId (or value) — you will paste it into the register curl as YOUR_CONTACT_ID.

The Contacts API does not expose separate reg/admin/tech/billing endpoints — pass the same contact ID as regContactId, adminContactId, techContactId, and billingContactId when registering.

7. Register the domain

Submit the registration with customer and contact IDs, initial nameservers, and billing options.

Try in playground: Register a new domain

Replace YOUR_DOMAIN, YOUR_CUSTOMER_ID, and YOUR_CONTACT_ID with your values. Use nameservers valid for your account (your reseller default NS or a DNS host you control).

invoiceOption controls invoicing behavior. Allowed values:

Value	Behavior
NoInvoice	No invoice; order executes
PayInvoice	Raise invoice; pay from debit if sufficient, else pending
KeepInvoice	Invoice for later; order executes
OnlyAdd	Invoice for later; registration pending

Save from response: copy orderId — you will paste it into the poll and nameserver curls as YOUR_ORDER_ID.

Example response:

Code
{
  "orderId": "987654321",
  "status": "Success",
  "message": "Domain registration initiated"
}

8. Track completion

Registration is asynchronous. Poll Search current actions filtered by orderId until the action reaches a terminal status.

Try in playground: Search current actions

Replace YOUR_ORDER_ID with the orderId from step 7. Poll every few seconds until actionStatus stabilizes.

Expected actionStatus values

The OpenAPI spec does not enumerate actionStatus values — use the actionStatus and actionStatusDesc fields in each action record. For a domain registration you will typically see:

Phase	Typical actionStatus	What it means
Queued	Added	Action is queued and waiting to run
Running	Being Processed	Registry or provisioning step is in progress
Done	Completed	Registration finished successfully
Error	Failed	Registration did not complete — check actionStatusDesc and message

When actionStatus is Completed (or the action no longer appears in current actions), proceed to nameservers. For archived actions, use Search archived actions.

Example poll response (abbreviated):

Code
{
  "actions": [
    {
      "orderId": "987654321",
      "actionType": "AddDomain",
      "actionStatus": "Being Processed",
      "actionStatusDesc": "Action is being processed"
    }
  ]
}

9. Update nameservers

Registration requires initial nameservers in step 7. This step shows how to change them after the order is active — for example, pointing the domain at your DNS host.

Try in playground: Update domain nameservers

Replace YOUR_ORDER_ID in the URL with the orderId from step 7. If auto-open does not show the playground, click Test in the sidecar panel on the operation page.

A successful update returns the updated nameserver list. Propagation can take up to 48 hours depending on the TLD and registry.

10. What's next

You have walked through the full reseller domain flow. Explore other API groups in the sidebar or jump to a reference:

• Actions — Pending and in-flight domain and account actions
• Contacts — Contact profile management
• Country — Country and region lookup data
• Customers — Customer account management
• DNS — DNS record and zone management
• Domain Forward — Domain forwarding configuration
• Domains — Domain registration, transfers, DNS, privacy, and related operations
• Orders — Order creation and management
• Products — Product catalog and pricing
• Resellers — Reseller and reseller product management

Each group expands to show OpenAPI tags and endpoints with an interactive Test panel.