HTTP API для реселерів Bestname
Інтеграція реєстрації та керування доменами з вашим сайтом.
Початок роботи
API повертає дані у форматі JSON та працює через HTTPS. Ключ доступний у кабінеті реселера; IP-адреси застосунку задаються в налаштуваннях кабінету.
У довідці нижче наведені команди перевірки, реєстрації, продовження, зміни NS, перегляду клієнтів, доменів, контактів і стану заявки. Для передачі даних використовуйте JSON або стандартне кодування полів POST.
З технічних питань звертайтесь до dev@besthosting.ua або служби підтримки.
Довідка з API
Усі команди використовують POST через HTTPS. Передайте api-key у тілі запиту, а IP вашого застосунку внесіть у налаштування реселлера. Не передавайте ключ у посиланні й не зберігайте його у відкритому коді. Параметри мають бути простими значеннями, без масивів; назви параметрів не перекладаються.
Для register, prolong та ns передавайте незмінний request-id при повторі того самого запиту: 8–80 літер латиниці, цифр, дефісів або підкреслень. Інша операція потребує іншого request-id. Без нього система створює новий ідентифікатор, тому повтор може стати новою заявкою.
debug=1 доступний для register, prolong та ns. Він перевіряє дані й повертає умовний order-id 1000 без створення замовлення або списання. Для реєстрації та продовження також перевіряється достатність балансу. Не використовуйте 1000 як номер реальної заявки.
PENDING означає очікування; PROCESSING — обробку або результат, що ще потребує з’ясування. DONE включає завершені, відхилені та скасовані заявки: це не окреме підтвердження успішної реєстрації. Підсумок перевіряйте у замовленні або в підтримки.
На адресах /api/… результат команди повертається в JSON з HTTP 200: перевіряйте success, а в разі помилки — descr. Обмеження частоти повертає HTTP 429. Невідомі команди та неправильний HTTP-метод не виконуються. Значення debug, protection, jur та block-mail передавайте як true/false або 1/0; рядок false означає вимкнено.
Наявні команди API
check — Перевірка доступності домену
Адреса POST:https://www.bestname.ua/api/check
Параметри крім api-key: domain — повне доменне ім’я.
Відповідь: success, available (true/false). simulation позначає тестову перевірку, якщо вона застосована.
register — Реєстрація домену
Адреса POST:https://www.bestname.ua/api/register
Параметри крім api-key: domain; period — строк у роках (типово 1, у межах зони); request-id; user-id — ваш наявний клієнт. Для нового клієнта замість user-id: email, fio, country (дволітерний код), region, city, address, zip, phone. Для юридичної особи: jur, company, edrpou. Додатково: ns1–ns3, ip1–ip3 для glue; block-mail; protection лише для платної підтримуваної міжнародної зони; license-ua для .ua; debug. Якщо NS не передані, застосовуються налаштування реселлера.
Відповідь: success, order-id. За відсутності debug створюється рахунок і списується баланс; це ще не завершення реєстрації.
prolong — Продовження домену
Адреса POST:https://www.bestname.ua/api/prolong
Параметри крім api-key: domain — домен вашого клієнта; period — доступний строк у роках; request-id; debug.
Відповідь: success, order-id. За відсутності debug створюється рахунок і списується баланс.
prolongprice — Вартість продовження
Адреса POST:https://www.bestname.ua/api/prolongprice
Параметри крім api-key: domain — домен вашого клієнта; period — доступний строк у роках.
Відповідь: success, price — масив із сумою за обраний строк у UAH. Ціна враховує правила зони та обрану Privacy Protection; списання не виконується.
ns — Зміна NS
Адреса POST:https://www.bestname.ua/api/ns
Параметри крім api-key: domain; ns1, ns2 і за потреби ns3; ip1–ip3 лише разом із відповідним NS для glue; request-id; debug. Потрібні щонайменше два різні NS.
Відповідь: success, order-id. Створення заявки не означає, що зміни вже виконані в реєстрі.
clients — Список клієнтів
Адреса POST:https://www.bestname.ua/api/clients
Параметри крім api-key: Додаткових параметрів немає.
Відповідь: success, clients — масив ID лише активних клієнтів цього реселлера.
domains — Домени клієнта
Адреса POST:https://www.bestname.ua/api/domains
Параметри крім api-key: client-id — ID вашого клієнта.
Відповідь: success, domains — масив доменних імен.
contacts — Контакти клієнта
Адреса POST:https://www.bestname.ua/api/contacts
Параметри крім api-key: client-id — ID вашого клієнта.
Відповідь: success, contacts: email, phone, country, region, city, address, jur, edrpou, company. Зберігайте персональні дані захищено; не записуйте повну відповідь у загальнодоступні логи.
status — Стан заявки
Адреса POST:https://www.bestname.ua/api/status
Параметри крім api-key: order-id — номер заявки, отриманий від API цього реселлера.
Відповідь: success, status: PENDING, PROCESSING або DONE.