Введение
HTTP API предоставляет простой способ интегрировать Ваш сайт или приложение с функциональностью нашего
сервиса регистрации и обслуживания доменных имен Bestname.ua
Для интеграции Вы можете использовать существующие библиотеки для работы с HTTP запросами и обработки
возвращаемых данных в формате JSON. Эти библиотеки доступны практически для всех языков программирования.
Хорошей практикой является кодирование данных при отправке команд API. Особенно важно использовать
кодирование при отправке персональных данных владельца домена в которых могут присутствовать специальные
символы.
Начало работы с API
Аутентификация реселлера посылающего запросы к API происходит по двум параметрам:
1. Один или несколько внесенных в белый список IP с которых будут производиться запросы к API.
2. Ко всем API запросам должен быть добавлен параметр API-KEY который можно получить в личном кабинете реселлера.
Все данные возвращаются в формате JSON. В случае успеха ответом будет номер заявки в очереди. Для
проверки статуса заявки нужно выполнить соответствующую команду API.
Для некоторых команд предусмотрена возможность посылки запроса в тестовом режиме. Для этого в POST запросе
нужно передать не пустой параметр debug. Тестовый режим предназначен для ознакомления с набором
возвращаемых данных и возможностью предварительной валидации передаваемых данных. Доступность тестового
режима указана в описании каждой команды ниже.
Техническая поддержка
Если у Вас возникнут вопросы технического характера, пожалуйста, обращайтесь по адресу dev@besthosting.ua
Список команд API
Проверка доступности доменного имени
Регистрация доменного имени
Продление доменного имени
Получение стоимости продления доменного имени
Смена NS
Получение списка клиентов реселлера
Получение списка доменов клиента
Получение данных клиента
Получение статуса ранее созданной заявки
Проверка доступности доменного имени
| HTTP Method | POST |
| URL запроса | https://www.bestname.ua/api/check |
| Тестовый запрос | Недоступен |
| Поле | Обязательное | Описание |
| api-key | Да | Персональный ключ реселлера |
| domain | Да | Название домена |
Пример передаваемых данных (POST):
api-key=YOURKEY
domain=domain.com
Ответ:
В случае успеха:
| Поле | Значение | Описание |
| success | true | |
| available | true / false | Домен свободен или занят (недоступен) для регистрации |
В случае неудачи:
| Поле | Значение | Описание |
| success | false | |
| descr | Text | Описание ошибки |
Регистрация доменного имени
| HTTP Method | POST |
| URL запроса | https://www.bestname.ua/api/register |
| Тестовый запрос | Доступен |
| Поле | Обязательное | Описание |
| api-key | Да | Персональный ключ реселлера |
| domain | Да | Название домена |
| period | Нет | Срок регистрации (количество лет). По умолчанию: 1 год. Допустимые периоды регистрации для зоны. |
| protection | Нет | Защита персональных данных. По умолчанию false. Доступно только для международных зон. |
| ns1 | Нет | Name Server. По умолчанию ns1.bestname.com.ua |
| ip1 | Нет | IP для NS1. По умолчанию пустое значение. |
| ns2 | Нет | Name Server. По умолчанию ns2.bestname.com.ua |
| ip2 | Нет | IP для NS2. По умолчанию пустое значение. |
| ns3 | Нет | Name Server. По умолчанию ns3.bestname.com.ua |
| ip3 | Нет | IP для NS3. По умолчанию пустое значение. |
| user-id | Да / Нет | Для регистрации домена на существующего пользователя указывается его id. Иначе поле не обязательно. |
| email | Да / Нет | Обязательно, если не указан user-id. Уникальный на Bestname.ua email для нового пользователя. |
| fio | Да / Нет | Обязательно, если не указан user-id. Полное ФИО нового пользователя. |
| country | Да / Нет | Обязательно, если не указан user-id. Код страны по стандарту ISO_3166-1 alpha-2 |
| region | Да / Нет | Обязательно, если не указан user-id. Название области. |
| city | Да / Нет | Обязательно, если не указан user-id. Название населенного пункта. |
| address | Да / Нет | Обязательно, если не указан user-id. Адрес. |
| zip | Да / Нет | Обязательно, если не указан user-id. Почтовый индекс. |
| phone | Да / Нет | Обязательно, если не указан user-id. Телефон в полном формате (код страны + код оператора + номер). Пример: 380961234567, 79871234567 |
| block-mail | Нет | Блокировать отправку сервисных писем клиенту. По умолчанию false. |
| jur | Нет | true - для юридического статуса нового пользователя. По умолчанию false (физическое лицо). |
| edrpou | Да / Нет | Обязательно, если не указан user-id и указан jur=true. Код ЕГРПОУ. |
| company | Да / Нет | Обязательно, если не указан user-id и указан jur=true. Название организации. |
| license-ua | Да / Нет | Обязательно для зоны UA. Номер лицензии торговой марки. |
Пример передаваемых данных (POST):
api-key=YOURKEYdomain=domain.comperiod=1user-id=11111
Пример передаваемых данных в тестовом режиме (POST):
api-key=YOURKEYdomain=domain.comperiod=1user-id=11111debug=true
Ответ:
В случае успеха:
| Поле | Значение | Описание |
| success | true | |
| order-id | Integer | Номер заявки в очереди |
В случае неудачи:
| Поле | Значение | Описание |
| success | false | |
| descr | Array | Описание ошибки |
Продление доменного имени
| HTTP Method | POST |
| URL запроса | https://www.bestname.ua/api/prolong |
| Тестовый запрос | Доступен |
| Поле | Обязательное | Описание |
| api-key | Да | Персональный ключ реселлера |
| domain | Да | Название домена |
| period | Нет | Срок продления (количество лет). По умолчанию: 1 год. Допустимые периоды продления для зоны. |
Пример передаваемых данных (POST):
api-key=YOURKEYdomain=domain.comperiod=1
Пример передаваемых данных в тестовом режиме (POST):
api-key=YOURKEYdomain=domain.comperiod=1debug=true
Ответ:
В случае успеха:
| Поле | Значение | Описание |
| success | true | |
| order-id | Integer | Номер заявки в очереди |
В случае неудачи:
| Поле | Значение | Описание |
| success | false | |
| descr | Text | Описание ошибки |
Получение стоимости продления доменного имени
| HTTP Method | POST |
| URL запроса | https://www.bestname.ua/api/prolongprice |
| Тестовый запрос | Недоступен |
| Поле | Обязательное | Описание |
| api-key | Да | Персональный ключ реселлера |
| domain | Да | Название домена |
| period | Нет | Срок продления (количество лет). По умолчанию: 1 год. Допустимые периоды продления для зоны. |
Пример передаваемых данных (POST):
api-key=YOURKEYdomain=domain.comperiod=1
Ответ:
В случае успеха:
| Поле | Значение | Описание |
| success | true | |
| price | Float | Стоимость продления домена на указанный период в грн. |
В случае неудачи:
| Поле | Значение | Описание |
| success | false | |
| descr | Text | Описание ошибки |
Смена NS
| HTTP Method | POST |
| URL запроса | https://www.bestname.ua/api/ns |
| Тестовый запрос | Доступен |
| Поле | Обязательное | Описание |
| api-key | Да | Персональный ключ реселлера |
| domain | Да | Название домена |
| ns1 | Да | адрес Name Server |
| ns2 | Да | адрес Name Server |
| ns3 | Да | адрес Name Server |
Пример передаваемых данных (POST):
api-key=YOURKEYdomain=domain.comns1=ns1.bestname.com.uans2=ns2.bestname.com.uans3=ns3.bestname.com.ua
Пример передаваемых данных в тестовом режиме (POST):
api-key=YOURKEYdomain=domain.comns1=ns1.bestname.com.uans2=ns2.bestname.com.uans3=ns3.bestname.com.uadebug=true
Ответ:
В случае успеха:
| Поле | Значение | Описание |
| success | true | |
| order-id | Integer | Номер заявки в очереди |
В случае неудачи:
| Поле | Значение | Описание |
| success | false | |
| descr | Text | Описание ошибки |
Получение списка клиентов реселлера
| HTTP Method | POST |
| URL запроса | https://www.bestname.ua/api/clients |
| Тестовый запрос | Недоступен |
| Поле | Обязательное | Описание |
| api-key | Да | Персональный ключ реселлера |
Пример передаваемых данных (POST):
api-key=YOURKEY
Ответ:
В случае успеха:
| Поле | Значение | Описание |
| success | true | |
| clients | Array | Массив клиентов с данными |
В случае неудачи:
| Поле | Значение | Описание |
| success | false | |
| descr | Text | Описание ошибки |
Получение списка доменов клиента
| HTTP Method | POST |
| URL запроса | https://www.bestname.ua/api/domains |
| Тестовый запрос | Недоступен |
| Поле | Обязательное | Описание |
| api-key | Да | Персональный ключ реселлера |
| client-id | Да | ID клиента полученный командой api/clients |
Пример передаваемых данных (POST):
api-key=YOURKEYclient-id=1111
Ответ:
В случае успеха:
| Поле | Значение | Описание |
| success | true | |
| domains | Array | Массив доменов клиента |
В случае неудачи:
| Поле | Значение | Описание |
| success | false | |
| descr | Text | Описание ошибки |
Получение данных клиента
| HTTP Method | POST |
| URL запроса | https://www.bestname.ua/api/contacts |
| Тестовый запрос | Недоступен |
| Поле | Обязательное | Описание |
| api-key | Да | Персональный ключ реселлера |
| client-id | Да | ID клиента полученный командой api/clients |
Пример передаваемых данных (POST):
api-key=YOURKEYclient-id=1111
Ответ:
В случае успеха:
| Поле | Значение | Описание |
| success | true | |
| contacts | Array | Массив данных клиента |
В случае неудачи:
| Поле | Значение | Описание |
| success | false | |
| descr | Text | Описание ошибки |
Получение статуса ранее созданной заявки
| HTTP Method | POST |
| URL запроса | https://www.bestname.ua/api/status |
| Тестовый запрос | Недоступен |
| Поле | Обязательное | Описание |
| api-key | Да | Персональный ключ реселлера |
| order-id | Да | Номер заявки |
Пример передаваемых данных (POST):
api-key=YOURKEYorder_id=1111
Ответ:
В случае успеха:
| Поле | Значение | Описание |
| success | true | |
| status | Text | Один из вариантов PENDING | PROCESSING | REJECTED | DONE |
В случае неудачи:
| Поле | Значение | Описание |
| success | false | |
| descr | Text | Описание ошибки |
Українська
Русский
English
