Quickstart

This guide takes you from reseller activation to your first domain registration. Each step includes a runnable cURL example that computes the hourly authentication token inline.

Order and activate reseller access

Order the Domain Reseller module from the store, verify your account email, then open the Reseller Area and copy your API key. Follow Order and activate reseller access for the full walkthrough.You need three values from Settings → API Details: the API URL (the endpoint), your API Email Address (your username), and your API Key.

Authenticate

Every request sends two headers: username (your reseller email) and token (an HMAC-SHA256 value that changes each UTC hour). See Authentication for the token formula and snippets in five languages.Confirm your credentials work by reading the API version:

API_KEY="your-api-key"
EMAIL="[email protected]"
ENDPOINT="https://portal.hostraha.com/modules/addons/DomainsReseller/api/index.php"
TS=$(date -u +"%y-%m-%d %H")
TOKEN=$(printf '%s' "$API_KEY" \
  | openssl dgst -sha256 -hmac "$EMAIL:$TS" -hex \
  | sed 's/^.*= //' | tr -d '\n' | base64 -w0)
curl -s "$ENDPOINT/version" \
  -H "username: $EMAIL" \
  -H "token: $TOKEN"

"2.3.0"

A "2.3.0"-style version string means your headers are valid.

Check availability

Look up a domain with POST /domains/lookup. Pass the search term and the TLDs to include.

curl -s "$ENDPOINT/domains/lookup" \
  -H "username: $EMAIL" \
  -H "token: $TOKEN" \
  --data "searchTerm=hostraha-demo-42" \
  --data "tldsToInclude[]=.com"

{
  "domainName": "hostraha-demo-42.com",
  "tld": "com",
  "sld": "hostraha-demo-42",
  "status": "available for registration",
  "legacyStatus": "available",
  "isRegistered": false,
  "isAvailable": true,
  "isValidDomain": true,
  "isPremium": false
}

See Check availability for every field.

Order the domain with POST /order/domains/register. Registration requires regperiod, nameservers, and a full set of contacts. See Register a domain for the complete body.

curl -s "$ENDPOINT/order/domains/register" \
  -H "username: $EMAIL" \
  -H "token: $TOKEN" \
  --data "domain=hostraha-demo-42.com" \
  --data "regperiod=1" \
  --data "nameservers[ns1]=ns1.hostraha.com" \
  --data "nameservers[ns2]=ns2.hostraha.com" \
  --data "contacts[registrant][firstname]=Jane" \
  --data "contacts[registrant][lastname]=Doe" \
  --data "contacts[registrant][email][email protected]"

"success"

A "success" response charges your reseller credits and creates the order. The domain provisions to your account once the account and order are active. Until then, management endpoints return a 403 “not found in reseller account”. See Credits and billing.

Getting started

Concepts

Next steps

Manage the domain

Handle errors

​Next steps

Manage the domain

Handle errors

Next steps