Bestname HTTP API for resellers
Integrate domain registration and management with your website.
Getting started
The API returns JSON and uses HTTPS. Obtain your key in the reseller account and configure your application IP addresses in account settings.
The reference below covers availability checks, registration, renewal, NS changes, customers, domains, contacts and order status. Send JSON or standard encoded POST fields.
For technical questions, contact dev@besthosting.ua or support.
API reference
All commands use POST over HTTPS. Send api-key in the request body and allow your application IP in reseller settings. Do not put the key in a URL or public source code. Parameters must be scalar values, not arrays; parameter names are not translated.
For register, prolong and ns, reuse the same request-id when retrying the same request: 8–80 Latin letters, digits, hyphens or underscores. A different operation needs a different request-id. Without it, a new identifier is generated and a retry may create another order.
debug=1 is supported by register, prolong and ns. It validates input and returns the placeholder order-id 1000 without creating an order or charging a balance. Registration and renewal also check sufficient funds. Do not treat 1000 as a real order number.
PENDING means waiting; PROCESSING means execution or an outcome still requiring reconciliation. DONE includes completed, rejected and cancelled orders: it is not a separate confirmation of successful registration. Check the order outcome or contact support.
Commands at /api/… return JSON with HTTP 200: check success and read descr on failure. Rate limiting returns HTTP 429. Unknown commands and incorrect HTTP methods are not executed. Send debug, protection, jur and block-mail as true/false or 1/0; the string false means disabled.
Existing API commands
check — Domain availability
POST URL:https://www.bestname.ua/api/check
Parameters besides api-key: domain — full domain name.
Response: success, available (true/false), simulation: true.
register — Domain registration
POST URL:https://www.bestname.ua/api/register
Parameters besides api-key: domain; period — years (default 1, subject to zone limits); request-id; user-id — your existing customer. For a new customer, replace user-id with email, fio, country (two-letter code), region, city, address, zip, phone. For a legal entity: jur, company, edrpou. Optional: ns1–ns3, ip1–ip3 for glue; block-mail; protection only for a paid supported international zone; license-ua for .ua; debug. If no NS are supplied, reseller defaults apply.
Response: success, order-id. Without debug, an invoice is created and the balance charged; registration is not yet complete.
prolong — Domain renewal
POST URL:https://www.bestname.ua/api/prolong
Parameters besides api-key: domain — your customer’s domain; period — supported years; request-id; debug.
Response: success, order-id. Without debug, an invoice is created and the balance charged.
prolongprice — Renewal price
POST URL:https://www.bestname.ua/api/prolongprice
Parameters besides api-key: domain — your customer’s domain; period — supported years.
Response: success, price — an array containing the selected term total in UAH. Zone rules and selected Privacy Protection apply; no charge is made.
ns — Nameserver change
POST URL:https://www.bestname.ua/api/ns
Parameters besides api-key: domain; ns1, ns2 and optional ns3; ip1–ip3 only with their matching NS for glue; request-id; debug. At least two distinct nameservers are required.
Response: success, order-id. Creating an order does not mean that registry changes have already completed.
clients — Customer list
POST URL:https://www.bestname.ua/api/clients
Parameters besides api-key: No additional parameters.
Response: success, clients — IDs of this reseller’s enabled customers only.
domains — Customer domains
POST URL:https://www.bestname.ua/api/domains
Parameters besides api-key: client-id — your customer ID.
Response: success, domains — an array of domain names.
contacts — Customer contacts
POST URL:https://www.bestname.ua/api/contacts
Parameters besides api-key: client-id — your customer ID.
Response: success, contacts: email, phone, country, region, city, address, jur, edrpou, company. Protect personal data; do not log the full response in public logs.
status — Order status
POST URL:https://www.bestname.ua/api/status
Parameters besides api-key: order-id — an order number returned by this reseller’s API.
Response: success, status: PENDING, PROCESSING or DONE.