Resellers API
1. Общие положения
Внимание!
API не предназначен для перехвата удаляющихся доменов, введены ограничения на количество запросов, за нарушения будем банить.
Для автоматизированного перехвата доступен специальный интерфейс.
- API доступен по HTTPS;
- доступны тестовая и рабочая версии API по адресам https://demo-api.evonames.com и https://hiapi.evonames.com соответственно;
- запросы шлются по адресу https://hiapi.evonames.com/apiCommand. Данные запроса передаются с помощью GET или POST переменных;
- для авторизация используются перменные auth_login и auth_password;
- результаты запроса возвращаются закодированными в JSON;
- в случае ошибки в возвращенном массиве будет элемент с ключом "_error" содержащий описание ошибки;
- допустимыми результатами запроса могут быть:
- скаляр "true"
- массив не содержащий элемент с ключом "_error" (в нём передаётся описание ошибки)
- любой другой результат, в том числе пустой - это ошибка
https://demo-api.evonames.com/domainsCheck?auth_login=demo&auth_password=demo&domains=test.com,adfwer234asdf.net
Пример полностью рабочий, можно скопировать URL в браузер и поиграться, посмотреть вывод ошибок.
2. Подробные примеры
В данной таблице приведена выдержка из справочника - полного списка всех доступных команд. На примере этих команд будет понятно как пользоваться справочником.
Команда: | Описание: | Аргументы: |
---|---|---|
domainsCheck | Проверка доступности доменов |
|
domainRegister | Регистрация доменов |
|
domainsRegister | Domains registration |
|
domainGetInfo | Get information of the domain |
|
domainsGetInfo | Get information of given domains |
|
domainSetNote | Установка клиентского примечания для домена |
|
domainsSetNote | Set client note for given domains |
|
2.1. domainsCheck
Единственный аргумент этой команды - "domains" - список доменнов через запятую для проверки их доступности для регистрации.
* - "звёздочка", значит что аргумент обязательный, если он не передан будет ошибка.
https://demo-api.evonames.com/domainsCheck?auth_login=demo&auth_password=demo&domains=test.com,adfwer234asdf.net
2.2. domainRegister
Обязательно указывать только имя домена, для остальных параметров предусмотрены дефолты.
https://demo-api.evonames.com/domainRegister?auth_login=demo&auth_password=demo&domain=test42345.com
2.3. domainsRegister
Пример bulk-операции - одновременно над несколькими объектами. В описании аргументов используется слово "массив" - обозначающее что должен передаваться массив каждый элемент которого подходит в качестве аргумента для указанной операции, в данном случае domainRegister.
https://demo-api.evonames.com/domainsRegister?auth_login=demo&auth_password=demo&0[domain]=test42345.com&1[domain]=test123123.net
2.4. domainGetInfo
Всё просто - надо передать имя или ID домена. Возвращает массив данных о домене.
https://demo-api.evonames.com/domainGetInfo?auth_login=demo&auth_password=demo&domain=test42345.com
2.5. domainsGetInfo
Bulk-операция - одновременно над несколькими объектами.
https://demo-api.evonames.com/domainsGetInfo?auth_login=demo&auth_password=demo&0[domain]=test42345.com&1[domain]=test.com
2.6. domainSetNote
Пустой или не преданный "note" - удаляет примечание.
https://demo-api.evonames.com/domainSetNote?auth_login=demo&auth_password=demo&domain=test.com¬e=abc
2.7. domainsSetNote
https://demo-api.evonames.com/domainsSetNote?auth_login=demo&auth_password=demo&0[domain]=test.com&0[note]=abc&1[domain]=test3.com&1[note]=def
3. Справочник типов
Тип | Описание |
---|---|
* |
Обязательное поле, значение должно быть непустое, не ноль, не пустая строка и не пустой список. Поля без звёздочки - необязательны для заполнения, могут не передаваться при вызове команды. |
id |
Айдишник. Целое число больше нуля. Например: 314123 |
ids |
Список айдишников, через запятую, пробельные символы допускаются. Например: 1234, 324534, 223423 |
domain |
Доменное имя Например: domain.com |
domains |
Список доменов, через запятую, пробельные символы допускаются. Например: domain.com, asdf.net |
ns |
Имя NS'а (name server'а). Например: ns1.domain.com |
nss |
Список NS'ов, через запятую, пробельные символы допускаются. Например: ns1.domain.com, ns2.domain.com |
eid |
Extended ID - расширенный айдишник. Допускаются цифры, латинские буквы и символы: '_.:-' (подчерк, точка, двоеточие, минус). Например: EID_234234:234-1 |
password |
Максимальная длина 64 символа. Не должен содержать символов переноса строки: \n, \r. Например: We\p!Jie6w |
period |
Целое число от 1 до 10. Используется для указания количества лет при регистрации и продлении. Например: 1 |
date expires |
Дата в ISO формате. Например: 2012-09-25 |
ref |
Идентификатор. Состоит только из цифр, латинских букв и подчерка. Ограничений на первый символ нет. Например: ok Например: 7days Например: 0001 |
refs |
Список идентификаторов, через запятую, пробельные символы допускаются. Например: ok, nok, 123 |
label |
Строка почти без ограничений. Не допускаются символы переноса строки. Например: Это имя клиента - Ivan Drago |
labels |
Список строк, через запятую, пробельные символы допускаются. Допускается передача массивом. Например: Ваня, Петя, Федя, John |
dnsName |
Пустая строка, "*", "@" либо строка не длиннее 100 символов, состоящая из не более чем 4 частей, разделенных ".", каждая из которых состоит из 1-61 символов следующих типов: латинские символы, цифры и знаки "-" и "_" (при этом "-" не может быть первым или последним символом). Например: *, @, n1, a1.b2, a1.b2.c3, a1.b2.c3.d4 |
4. Справочник команд
Команда | Описание | Аргументы |
---|---|---|
domainsCheck | Проверка доступности доменов |
|
domainsSearch | List/Search domains |
|
domainRegister | Регистрация доменов |
|
domainsRegister | Register domains |
|
domainTransfer | Start domain transfer |
|
domainsTransfer | Start domains transfer |
|
domainGetNSs | Get name servers of the domain |
|
domainsGetNSs | Get name servers of domains |
|
domainSetNSs | Установка NS'ов для домена |
|
domainsSetNSs | Set name servers for given domains |
|
domainGetNote | Get domain note |
|
domainsGetNote | Get domains note |
|
domainSetNote | Установка клиентского примечания для домена |
|
domainsSetNote | Set client note for given domains |
|
domainRenew | Domain renew |
|
domainGetPassword | Get domain password |
|
domainsGetPassword | Get domains password |
|
domainRegenPassword | Domain regen password |
|
domainsRegenPassword | Domains regen password |
|
domainGetInfo | Get information of the domain |
|
domainsGetInfo | Get information of given domains |
|
domainGetContacts | Get contacts of the domain |
|
domainGetWPContacts | Get WHOIS protected contacts of the domain |
|
domainGetContactsInfo | Get contacts info of the domain |
|
domainGetWPContactsInfo | Get WHOIS protected contacts info of the domain |
|
domainsGetContacts | Get contacts of given domains |
|
domainsGetWPContacts | Get WHOIS protected contacts of given domains |
|
domainsGetContactsInfo | Get contacts info of given domains |
|
domainsGetWPContactsInfo | Get WHOIS protected contacts info of given domains |
|
domainSetContacts | Set domain contacts |
|
domainsSetContacts | Set contacts for given domains |
|
domainEnableAutorenewal | Enable autorenewal for the domain |
|
domainDisableAutorenewal | Disable autorenewal for the domain |
|
domainsEnableAutorenewal | Enable autorenewal for given domains |
|
domainsDisableAutorenewal | Disable autorenewal for given domains |
|
domainEnableWhoisProtect | Enable whois protect for the domain |
|
domainDisableWhoisProtect | Enable whois protect for the domain |
|
domainsEnableWhoisProtect | Enable whois protect for given domains |
|
domainsDisableWhoisProtect | Disable whois protect for given domains |
|
domainEnableLock | Enable lock for the domain |
|
domainDisableLock | Disable lock for the domain |
|
domainsEnableLock | Enable lock for given domains |
|
domainsDisableLock | Disable lock for given domains |
|
domainGetDNS | Get DNS settings for given domain |
|
domainsGetDNS | Get DNS settings for given domains |
|
domainSetDNS | Set DNS settings for given domain |
|
domainsSetDNS | Set DNS settings for given domains |
|
hostsSearch | Hosts search |
|
hostGetInfo | Host get info |
|
hostsGetInfo | Hosts get info |
|
hostCreate | Host create |
|
hostsCreate | Hosts create |
|
hostUpdate | Host update |
|
hostsUpdate | Hosts update |
|
contactsSearch | List/Search contacts |
|
contactGetInfo | Get contact info |
|
contactsGetInfo | Get contacts info |
|
contactCreate | Создать контакт |
|
contactsCreate | Create contacts |
|
contactUpdate | Update contact |
|
contactsUpdate | Update contacts |
|
clientGetBalance | Получить баланс клиента |
|
clientGetPrices | Get client prices |
|
clientsGetPrices | Get clients prices |
|