Общая информация
- Системой поддерживается возможность автоматизированной подачи заявок на регистрацию освобождающихся доменов в зонах .RU и .РФ
- Все функции работают как с GET, так и с POST методами
- Все функции требуют авторизации (исключением является сама авторизация)
- Все функции могут возвращать результат в двух форматах: JSON или XML — формат регулируется параметром out
- В случае ошибки, в ответ будет включена нода /doc/error с описанием возникшего исключения
Авторизация
Авторизация возможна двумя способами:
- Добавлением ко всем запросам параметра authinfo=[LOGIN]:[PASSWORD]
- Добавлением ко всем запросам параметра auth, значение для которого возвращается при выполнении функции auth (@see #auth)
Функции
#auth — авторизация
Параметры:
Название |
Тип |
Обязательный |
Описание |
username |
string |
+ |
Логин для входа в биллинговую систему |
password |
string |
+ |
Пароль для входа в биллинговую систему |
out |
string |
|
Формат вывода: "xml" или "json" |
Результат:
XMLDocument | JSONObject
Пример:
curl 'https://api.expired.ru/billmgr?func=auth&username=test&password=testpwd&out=xml'
<?xml version="1.0" encoding="UTF-8"?>
<doc lang="en" func="auth" binary="/billmgr" host="https://expired.ru" theme="orion" stylesheet="login" features="" notify="">
<auth id="1234567890" level="16">1234567890</auth>
<tparams>
<out>xml</out>
<username>test</username>
<func>auth</func>
</tparams>
</doc>
#backorder.api.set — подать заявку на освободающийся домен / повысить тариф для существующей заявки
Параметры:
Название |
Тип |
Обязательный |
Описание |
domain |
string |
+ |
Освобождающийся домен |
contact |
int |
+ |
ID контакта в системе |
price |
int |
+ |
Стоимость выбранного тарифа: 199, 599... |
out |
string |
|
Формат вывода: "xml" или "json" |
Результат:
XMLDocument | JSONObject
Пример:
curl 'https://api.expired.ru/billmgr?func=backorder.api.set&auth=1234567890&out=xml&domain=test.ru&contact=1234&price=599'
<doc features="" notify="5">
<ok/>
<id>455837</id>
<tparams>
<auth>1234567890</auth>
<contact>1234</contact>
<domain>test.ru</domain>
<out>xml</out>
<price>599</price>
</tparams>
</doc>
#backorder.api.list — получить список заявок
Параметры:
Название |
Тип |
Обязательный |
Описание |
out |
string |
|
Формат вывода: "xml" или "json" |
Результат:
XMLDocument | JSONObject
Пример:
curl 'https://api.expired.ru/billmgr?func=backorder.api.list&auth=1234567890&out=xml'
<doc features="" notify="5">
<ok/>
<bids>
<bid>
<id>455837</id>
<domain>test.ru</domain>
<price>599</price>
<tariff>Тариф 1</tariff>
<freedate>2017-02-21</freedate>
<registrars>11 / 12 (36 %)</registrars>
<status>Заявка активна</status>
</bid>
<bid>
<id>455839</id>
<domain>test1.ru</domain>
<price>199</price>
<tariff>Тариф Базовый</tariff>
<freedate>2017-02-16</freedate>
<registrars>10 / 12 (28 %)</registrars>
<status>Заявка активна</status>
</bid>
</bids>
<tparams>
<auth>1234567890</auth>
<out>xml</out>
</tparams>
</doc>
#backorder.api.prices — получить информацию о доступности тарифов на освобождающийся домен
Параметры:
Название |
Тип |
Обязательный |
Описание |
domain |
string |
+ |
Освобождающийся домен |
out |
string |
|
Формат вывода: "xml" или "json" |
Результат:
XMLDocument | JSONObject
Пример:
curl 'https://api.expired.ru/billmgr?func=backorder.api.prices&domain=test.ru&auth=1234567890&out=xml'
<doc features="9d88a90f3bdace244f0cc29aeea9ea600" notify="8">
<ok/>
<prices>
<price>
<id>4356</id>
<name>Тариф 2</name>
<price>999</price>
<registrars>12 / 12</registrars>
</price>
<price>
<id>4357</id>
<name>Тариф 3</name>
<price>2999</price>
<registrars>12 / 12</registrars>
</price>
<price>
<id>4358</id>
<name>Тариф 4</name>
<price>4999</price>
<registrars>12 / 12</registrars>
</price>
<price>
<id>4359</id>
<name>Тариф 5</name>
<price>9999</price>
<registrars>12 / 12</registrars>
</price>
<price>
<id>4360</id>
<name>Тариф 6</name>
<price>14999</price>
<registrars>12 / 12</registrars>
</price>
<price>
<id>4361</id>
<name>Тариф 7</name>
<price>29999</price>
<registrars>12 / 12</registrars>
</price>
<price>
<id>4362</id>
<name>Тариф 8</name>
<price>49999</price>
<registrars>12 / 12</registrars>
</price>
<price>
<id>22033</id>
<name>Тариф 9</name>
<price>74999</price>
<registrars>12 / 12</registrars>
</price>
<price>
<id>4363</id>
<name>Тариф 10</name>
<price>99999</price>
<registrars>12 / 12</registrars>
</price>
<price>
<id>22034</id>
<name>Тариф 11</name>
<price>149000</price>
<registrars>12 / 12</registrars>
</price>
<price>
<id>22035</id>
<name>Тариф 12</name>
<price>199000</price>
<registrars>12 / 12</registrars>
</price>
</prices>
<tparams>
<auth>1234567890</auth>
<domain>test.ru</domain>
<out>xml</out>
</tparams>
</doc>
#backorder.api.delete — удалить неактивную заявку на освобождающийся домен
Параметры:
Название |
Тип |
Обязательный |
Описание |
domain |
string |
+ |
Освобождающийся домен |
out |
string |
|
Формат вывода: "xml" или "json" |
Результат:
XMLDocument | JSONObject
Пример:
curl 'https://api.expired.ru/billmgr?func=backorder.api.delete&auth=1234567890&out=xml&domain=test.ru'
<doc features="" notify="5">
<ok/>
<id>455837</id>
<tparams>
<auth>1234567890</auth>
<domain>test.ru</domain>
<out>xml</out>
</tparams>
</doc>
#domain.ns — задать NS сервера для домена
Параметры:
Название |
Тип |
Обязательный |
Описание |
elid |
int |
+ |
ID домена в системе |
ns0 |
string |
|
NS1 |
ns1 |
string |
|
NS2 |
ns2 |
string |
|
NS3 |
ns3 |
string |
|
NS4 |
sok |
string |
|
Всегда передавать 'ok' |
out |
string |
|
Формат вывода: "xml" или "json" |
Результат:
XMLDocument | JSONObject
Пример:
curl 'https://api.expired.ru/billmgr?func=domain.ns&auth=1234567890&out=xml&elid=92332&ns0=ns1.example.com&ns1=ns2.example.com&sok=ok'
<doc>
<doc>
<ns0>ns1.example.com</ns0>
<ns1>ns2.example.com</ns1>
<ns2/>
<ns_additional/>
<elid>92332</elid>
<ns3/>
<tparams>
<auth>1234567890</auth>
<elid>92332</elid>
<ns0>ns1.example.com</ns0>
<ns1>ns2.example.com</ns1>
<ns2/>
<ns3/>
<out>devel</out>
<func>domain.ns</func>
</tparams>
<saved_filters/>
</doc>
<ok/>
<tparams>
<auth>1234567890</auth>
<elid>92332</elid>
<ns0>ns1.example.com</ns0>
<ns1>ns2.example.com</ns1>
<ns2/>
<ns3/>
<out>xml</out>
<func>domain.ns</func>
</tparams>
<saved_filters/>
</doc>