Quickstart

Use the read-only GET /version operation for the first connectivity check. Do not begin with registration, renewal, contact, nameserver, lock, sync, or EPP operations because their side effects or retry behavior are not fully documented.

1. Generate the Token

Obtain the reseller account email and API key from Register.ly. Generate the token server-side using the published PHP expression on Authentication, and verify the result against your live API integration before translating it to another language.

2. Set the Headers

Set username to the reseller account email and token to the generated value. Keep the API key out of the request and browser code.

VALIDATION REQUIRED: Cross-language token generation is deferred until Register.ly publishes byte-level test vectors.

3. Call GET /version

Get version string

curl --request GET \
  --url "https://my.register.ly/modules/addons/DomainsReseller/api/index.php/version" \
  --header "username: [email protected]" \
  --header "token: <generated-token>"

4. Confirm Authentication

The published success example is a JSON string:

"2.2.3"

Receiving the documented HTTP 200 JSON string confirms that this request was authenticated and processed. The meaning of the version value itself is not yet established; it may identify the API, module, backend implementation, or build.

VALIDATION REQUIRED: Authentication failure HTTP status and response body.

Next: Check Availability

After authentication works, use the read-only Domain Availability request with controlled test input. Note the unresolved leading-dot difference between lookup input and /tlds output.