by Walery Studennikov <despair@cpan.org>
Это справочное руководство описывает HTTP-шлюз
к системе распределённой регистрации Reg.Ru (далее RegruSRS)
версии 1.0.0.
HTTP-шлюз — это метод взаимодействия с системой распределённой
регистрации RegRuSRS, позволяющий осуществлять операции в
реальном времени за один шаг.
Для осуществления одношаговых (одноэтапных) операций,
вся информация должна быть представлена в одном единственном HTTP-запросе.
В интерфейсе RegRuSRS нет понятия "состояния" и все запросы независимы
друг от друга. HTTP-интерфейс поддерживает такие операции как
регистрация домена, смена DNS серверов домена, проверка доступности
домена, смена регистрационных данных домена и т.п.
Доступные операции описаны ниже в этом документе.
Запросы к HTTP-шлюзу должны направляться на URL
https://www.reg.ru/api/regruили
http://www.reg.ru/api/regru
Среднее время ответа при нормальных нагрузках сервера должно быть не более 5 или 10 секунд.
Все запросы должны удовлетворять спецификации HTTP/1.0 или HTTP/1.1, описанной в RFC 1945:
http://www.ics.uci.edu/pub/ietf/http/rfc1945.html
REG.RU предоставляет тестовый доступ к своему шлюзу для тестирования системы регистрации. Отличия тестового доступа от реального таковы:
Для использования тестовой системы, HTTP-Post запросы должны направляться на тот же URL, что и для реальной системы. При этом используются следующие авторизационные данные:
username: test
password: test
При использовании интерфейса RegRuSRS клиентом должен быть соблюдён ряд ограничений.
HTTP-шлюз позволяет осуществлять различные операции. В таблице ниже приведён список операций, которые могут быть осуществлены с использованием HTTP-шлюза. Для каждой операции требуется указание различных параметров (полей), которые описаны ниже в этом документе.
Операция |
Описание | Примеры | Разрешения |
---|---|---|---|
Операции с доменами (см. раздел 4) | |||
domain_create | Подать заявку на регистрацию домена | gtld, ru_org, ru_pp | |
domain_trans_in | Подать заявку на перенос домена от другого регистратора | gtld, ru | |
domain_check | Проверка доступности домена для регистрации | Пример | Все |
domain_whois | Получение данных WHOIS для домена | Пример | Все |
domain_renew | Продление регистрации домена | Пример | Вл. |
domain_update_nss | Смена списка DNS-серверов домена | Пример | Вл., ПЧУ |
domain_update_contacts | Смена данных владельца домена | gtld, ru_org, ru_pp | Вл., ПЧУ |
domain_delete | Отмена регистрации домена | Не реализовано | Вл. |
domain_owner_change | Смена владельца домена | Не реализовано | Вл. |
domain_partcontrol_grant | Дать полномочия по управлению доменом другому пользователю | Пример | Вл. |
domain_partcontrol_revoke | Забрать полномочия по управлению доменом от другого пользователя | Пример | Вл. |
domain_get_approval_status | Получение статуса ручной проверки данных владельца | Пример | Вл., ПЧУ |
domain_get_info | Получение информации о домене | Пример | Вл., ПЧУ |
domain_get_contacts | Получение данных владельца домена | Пример | Вл., ПЧУ |
domain_get_nss | Получение списка DNS-серверов домена | Пример | Вл., ПЧУ |
domain_ns_register | Зарегистрировать DNS-сервер в NSI-registry (для .com, .net, .org) | Не реализовано | Вл., ПЧУ |
domain_ns_unregister | Удалить регистрацию DNS-сервера из NSI-registry (для .com, .net, .org) | Не реализовано | Вл., ПЧУ |
Операции по управлению зоной (см. раздел 5) |
|||
zone_add_rr | Добавление ресурсной записи | A, CNAME, MX, NS, TXT | Вл., ПЧУ |
zone_rm_rr | Удаление записи | Пример | Вл., ПЧУ |
zone_update | Обновление зоны | Пример | Вл., ПЧУ |
zone_tune_park | Настройка зоны для парковки | Не реализовано | Вл., ПЧУ |
zone_tune_host | Настройка зоны для хостинга | Не реализовано | Вл., ПЧУ |
zone_get_info | Получение информации о зоне | Не реализовано | Вл., ПЧУ |
Прочие операции (см. раздел 6) |
|||
balance_refill | Выписка счёта на предоплату (пополнение баланса) | Пример | Польз./td> |
balance_get | Получение значения текущего баланса | Пример | Польз./td> |
Пояснения по колонке "Разрешения":
Команды на осуществление операций передаются в виде стандартного запроса HTTP/1.0 POST. Параметры операции передаются в виде HTTP параметров. При этом действуют следующие правила:
В таблице перечислены все обязательные поля, которые должны присутствовать в КАЖДОМ запросе.
Имя поля | Макс. длина | Описание |
---|---|---|
action | 80 | Определяет операцию, которая должна быть произведена, например domain_check |
username | 80 | Имя пользователя (login) в системе регистрации RegRuSRS. |
password | 80 | Пароль пользователя (password) в системе регистрации RegRuSRS. |
domain_name | 67 | Полное имя домена, с которым производится операция, например example.com. Максимальная длина - 67 символов (63 + 4). Допустимы алфавитно-цифровые символы и символ дефиса. Русские имена доменов указываются в кодировке windows-1251 (CP1251). |
extended_message_lang | 2 | Язык расширенных сообщений об ошибках ('ru', 'en' либо не указывается). Подробности см. разделе 3.5 |
fail_if_no_money | 1 | Возвращать ошибку, если денег на лицевом счёте для исполнения заявки недостаточно. По умолчанию (если данный флаг не выставлен) заявка в системе создаётся, однако эта заявка будет исполнена только после выполнения операции "сменить способ оплаты счёта" через web-интерфейс системы. |
no_bill_notify | 1 | Не высылать уведомление по электронной почте о заказе. По умолчанию для каждого нового заказа (любая операция по регистрации, переносу и продлению домена регистрируется как отдельный заказ в системе регистрации) отсылвается уведомление на email, указанный в настройках эккаунта партнёра. Если выставлен флаг no_bill_notify — уведомление по email не отсылается. |
Ниже перечислены сообщения об ошибках системы RegRuSRS, общие для всех операций:
Текст ошибки | Описание |
---|---|
Error: no username given | Значение поля "username" не указано. |
Error: no password given | Значение поля "password" не указано. |
Error: no action given | Значение поля "action" не указано. |
Error: username/password Incorrect | Такого пользователя не существует либо пароль пользователя указан неверно. |
Error: domain_name is invalid | Значение поля "domain_name" не указано или указано неверно: т.е. содержит недопустимые символы, превышает допустимую длину и т.п. |
Error: <domain name> not found | Домен не существует или информация WHOIS по этому домену ещё не доступна. |
Error: Domain name <domain name> not found or not owned by you | Указанный домен не найден в системе, либо принадлежит другому пользователю. |
Error: The following fields are invalid: <fields list> | Значения перечисленных полей неверны. Исправьте данные и повторите запрос. |
Error: Unknown action: <action> | Неверный / несуществующий код операции (функции). |
Error: System Unavailable | Шлюз RegRuSRS не доступен. Операция не была произведена и запрос должен быть подан повторно. |
Error: Internal error\n<error msg> | Внутренняя ошибка системы RegRuSRS. Пожалуйста, свяжитесь с REG.RU (support@reg.ru) для решения проблемы. |
Если указано значение поля "extended_message_lang", система выдаёт расширенные сообщения об успешных операциях и ошибках на указанном языке ('ru' или 'en') Если поле "extended_message_lang" отсутствует в запросе, то расширенные сообщения не возвращаются.
Подробности о режиме расширенных сообщений:
В данном режиме поддерживаются многострочные сообщения о выполненных операциях и об ошибках.
Первая строчка имеет строгий формат, описанный в этом документе в списке возможных
ответов системы для каждой команды.
За первой строчкой могут следовать (но не обязательно следуют) дополнительные
строчки с развёрнутым описанием ошибки системы или комментария к операции.
Формат описания свободный (не регламентирован) и предназначен для расшифровки
ответов системы в удобной для восприятия человеком форме.
Язык развёрнутых сообщений об зависит от значения поля "extended_message_lang",
присутствующего в запросе. Допускаются русский ('ru') и английский ('en')
языки.
Имя поля | Мин. длина | Макс. длина | Описание поля |
---|---|---|---|
period | 1 | 2 | Период, на который производится регистрация домена. Единственное допустимое значение для доменов .ru и .su: 1. |
descr | 5 | 255 | Описание домена. Заполняется по-английски. Необязательное поле. |
Контактные данные организации (только при регистрации домена на организацию!) | |||
org | 6 | 255 много- строчное |
Полное наименование организации - администратора домена латинскими
буквами, предназначенное для использования сервисом 'whois'. Запись
может быть многострочной. Пример1: Karla-Marla Uryupinsk State University Пример2: "ROGA I KOPYTA", LTD. |
org_r | 10 | 255 много- строчное |
Полное наименование организации - администратора домена на русском языке
в соответствии с учредительными документами. Для нерезидентов
указывается написание на национальном языке (либо на
английском языке). Запись может быть многострочной. Пример1: Урюпинский государственный университет\nимени Карлы-Марлы Пример2: Общество с ограниченной ответственностью "Рога и Копыта" |
code | 10 | 10 |
Идентификационный номер налогоплательщика (ИНН), присвоенный
организации-администратору. Запись может содержать пустую строку, если
администратором является нерезидент РФ, не имеющий идентификационного
номера налогоплательщика. Пример: 7701107259 |
kpp | 9 | 9 |
КПП организации (для Российских организаций). Необязательное поле. Пример: 632946014 |
country | 2 | 2 |
Двухбуквенный ISO-код страны, в которой зарегистрирована организация
Пример: RU |
address_r | 15 | 255 много- строчное |
Юридический адрес организации в соответствии с учредительными
документами. Запись может быть многострочной. Пример: 101000, Москва, ул.Пупкина, 1, стр. 2 |
p_addr | 15 | 255 много- строчное |
Почтовый адрес организации - администратора домена.
Запись может быть многострочной. Пример: 101000, Москва, ул.Пупкина, 1, стр. 2, отдел мебели,\n офис 433 (для В. Лоханкина) |
phone | 8 | 255 много- строчное |
Номер телефона администратора домена. Телефон указывается с
международным кодом (включая символ +); международный код, код
города и местный номер разделяются пробелами. Скобки и дефисы не
допускаются. Запись может быть многострочной. Пример: +7 495 8102233\n+7 3432 811221 |
fax | 8 | 255 много- строчное |
Номер телефакса администратора домена. Номер телефакса указывается с международным кодом (включая символ +); международный код, код города и местный номер разделяются пробелами. Скобки и тире не допускаются. Запись может быть многострочной. Запись не является обязательной. Пример: +7 3432 811221\n+7 495 8102233 |
e_mail | 6 | 255 много- строчное |
Адрес электронной почты администратора домена в формате RFC-822. Запись может быть многострочной. Пример: ncc@test.ru\ntest@test.ru |
Контактные данные частного лица (только при регистрации домена на частное лицо!) | |||
person | 8 | 64 |
Имя, первая буква отчества (без точки) и фамилия администратора домена,
записанные латинскими буквами. Предназначено для использования сервисом
'whois'. Для иностранцев поле содержит имя в оригинальном написании
(или в английской транскрипции). Пример: Vassily N Pupkin |
person_r | 9 | 64 |
Фамилия, имя и отчество администратора домена на русском языке в
соответствии с паспортными данными. Для иностранцев поле содержит имя в
оригинальном написании (при невозможности в английской транскрипции). Пример1: Пупкин Василий Николаевич Пример2: John Smith |
passport | 20 | 255 много- строчное |
Серия и номер паспорта, а также наименование органа, выдавшего паспорт,
и дата выдачи (в указанной последовательности, с разделением пробелами).
В написании римских цифр допустимо использование только латинских букв.
Дата записывается в формате ДД.ММ.ГГГГ.
Знак номера перед номером паспорта не ставится.
Паспорта СССР (паспорта старого образца) не принимаются.
В случае использования документа, отличного от паспорта
(допустимо ТОЛЬКО для нерезидентов России), в начале строки указывается
наименование вида документа. Запись может быть многострочной. Пример: 34 02 651241 выдан 48 о/м г.Москвы 26.12.1990 |
birth_date | 10 | 10 |
Дата рождения администратора домена в формате ДД.ММ.ГГГГ. Пример: 07.11.1917 |
country | 2 | 2 |
Двухбуквенный ISO-код страны, гражданином которой является частное лицо
Пример: RU |
p_addr | 15 | 255 много- строчное |
Почтовый адрес администратора домена на русском языке. (Адрес может
не совпадать с указанным в паспорте местом регистрации.)
Запись может быть многострочной. Пример: 101000, Москва, ул.Воробьянинова, 15,\n кв.22, В. Лоханкину. |
phone | 8 | 255 много- строчное |
Номер телефона администратора домена. Телефон указывается с
международным кодом (включая символ +); международный код, код города
и местный номер разделяются пробелами. Скобки и тире не допускаются.
Запись может быть многострочной. Пример: +7 495 8102233\n+7 3432 811221 |
fax | 8 | 255 много- строчное |
Номер телефакса администратора домена. Номер телефакса указывается с
международным кодом (включая символ +); международный код, код города
и местный номер разделяются пробелами. Скобки и тире не допускаются.
Запись может быть многострочной. Пример: +7 3432 811221\n+7 495 5555342 |
e_mail | 6 | 255 много- строчное |
Адрес электронной почты администратора домена в формате RFC-822.
Запись может быть многострочной. Пример: ncc@test.ru\ntest@test.ru |
code | 12 | 12 |
Идентификационный номер налогоплательщика (ИНН), присвоенный
администратору домена. Параметр указывается только в том случае, если
администратор выступает как индивидуальный предприниматель. Пример: 789012345678 |
DNS-серверы домена (должно быть указано не менее двух серверов) | |||
ns0 | 6 | 80 | Имя хоста первого DNS-сервера. [% UNLESS chgdns %][% END %] |
ns1 | 6 | 80 | Имя хоста второго DNS-сервера. [% UNLESS chgdns %][% END %] |
ns2 | 6 | 80 | Имя хоста третьего DNS-сервера. |
ns3 | 6 | 80 | Имя хоста четвёртого DNS-сервера. |
ns0ip | 8 | 15 | IP-адрес первого DNS-сервера. Необязательное поле. Используется только если имя DNS-сервера содержит имя регистрируемого домена |
ns1ip | 8 | 15 | IP-адрес второго DNS-сервера. Необязательное поле. Используется только если имя DNS-сервера содержит имя регистрируемого домена |
ns2ip | 8 | 15 | IP-адрес третьего DNS-сервера. Необязательное поле. Используется только если имя DNS-сервера содержит имя регистрируемого домена |
ns3ip | 8 | 15 | IP-адрес четвёртого DNS-сервера. Необязательное поле. Используется только если имя DNS-сервера содержит имя регистрируемого домена |
Примечание:
Для поддержки DNS могут быть бесплатно использованы сервера REG.RU.
Для этого в качестве DNS-серверов необходимо указать сервера
ns1.nameself.com и ns2.nameself.com.
При этом на данных серверах будет прописана зона для Вашего домена.
Управлять зоной впоследствии можно будет через web-интерфейс
портала reg.ru.
[% END # dns_rdap %]
[% PROCESS dns_rdap %]
Имя поля | Мин. длина | Макс. длина | Описание поля |
---|---|---|---|
period | 1 | 2 | Период, на который производится регистрация домена. Интервал допустимых значений: 1 - 10 |
Данные владельца домена | |||
o_company | 5 | 80 | Название организации - владельца домена. Указывать "Private person" в случае, если владельцем является частное лицо. |
o_first_name | 2 | 40 | Имя контактного лица |
o_last_name | 2 | 40 | Фамилия контактного лица |
o_email | 6 | 90 | Контактный email-адрес владельца домена. |
o_phone | 8 | 20 | Номер телефона владельца домена в международном формате (Пример: +7.4952171179). |
o_fax | 8 | 20 | Номер факса владельца домена в международном формате (Пример: +7.4952171179). Необязательное поле. |
o_addr | 8 | 80 | Адрес владельца домена: улица, дом, офис (квартира) |
o_city | 2 | 80 | Адрес владельца домена: город |
o_state | 2 | 40 | Адрес владельца домена: область/край/штат |
o_postcode | 3 | 10 | Почтовый индекс владельца домена |
o_country_code | 2 | 2 | Двухбуквенный ISO-код страны владельца домена. Список всех кодов стран можно найти тут |
Данные администратора домена | |||
a_company | 5 | 80 | Организация - администратор домена. Указывать "Private person" в случае, если администратором является частное лицо. |
a_first_name | 2 | 40 | Имя контактного лица |
a_last_name | 2 | 40 | Фамилия контактного лица |
a_email | 6 | 80 | Email-адрес контактного лица |
a_phone | 8 | 20 | Номер телефона контактного лица в международном формате (Пример: +7.4952171179). |
a_fax | 8 | 20 | Номер факса контактного лица в международном формате (Пример: +7.4952171179). Необязательное поле. |
a_addr | 8 | 80 | Адрес контактного лица: улица, дом, офис (квартира) |
a_city | 2 | 80 | Адрес контактного лица: город |
a_state | 2 | 40 | Адрес контактного лица: область/край/штат |
a_postcode | 3 | 10 | Почтовый индекс контактного лица |
a_country_code | 2 | 2 | Двухбуквенный ISO-код страны контактного лица. Список всех кодов стран можно найти тут |
Данные техподдержки домена | |||
t_company | 5 | 80 | Организация, осуществляющая техподдержку домена. Указывать "Private person" в случае, если техподдержку осуществляет частное лицо. |
t_first_name | 2 | 40 | Имя контактного лица |
t_last_name | 2 | 40 | Фамилия контактного лица |
t_email | 6 | 80 | Email-адрес контактного лица |
t_phone | 8 | 20 | Номер телефона контактного лица в международном формате (Пример: +7.4952171179). |
t_fax | 8 | 20 | Номер факса контактного лица в международном формате (Пример: +7.4952171179). Необязательное поле. |
t_addr | 8 | 80 | Адрес контактного лица: улица, дом, офис (квартира) |
t_city | 2 | 80 | Адрес контактного лица: город |
t_state | 2 | 40 | Адрес контактного лица: область/край/штат |
t_postcode | 3 | 10 | Почтовый индекс контактного лица |
t_country_code | 2 | 2 | Двухбуквенный ISO-код страны контактного лица. Список всех кодов стран можно найти тут | [% END # gtld_contacts %] [% PROCESS gtld_contacts %] [% PROCESS dns_servers %]
Эта операция позволяет подавать заявки на перенос доменов .COM .NET .ORG .BIZ .INFO .US .RU и .SU от других регистраторов к ООО "Регистратор доменных имён РЕГ.РУ". В качестве значения параметра action для этой операции должно быть установлено domain_trans_in.
Для доменов .RU и .SU данные владельца домена и DNS-сервера не указываются. Эти данные будут автоматически получены из реестра в момент принятия домена. Также для доменов .RU и .SU поле "period" может принимать значение "0" (перенос доменов без продления). Для всех прочих доменов, при переносе указываются все поля, что и для операции регистрации доменов (см. раздел 4.1.2).
Ответ системы | Описание |
---|---|
Success: Registration request accepted for <domain name> for <period> years |
Заявка на регистрацию домена была успешно принята.
При установленном флаге "extended_message_lang"
возвращаются дополнительные комментарии о том,
достаточно ли средств на лицевом счёте для выполнения операции. Возможные форматы сообщений: "<XXX> USD (including VAT <YYY> USD) successfully charged", "Order not payed - not enough money at account". |
Success: Transfer request accepted for <domain name> |
Заявка на перенос домена была успешно принята.
При установленном флаге "extended_message_lang"
возвращаются дополнительные комментарии о том,
достаточно ли средств на лицевом счёте для выполнения операции
либо сообщение о том, что оплаты не требуется. Возможные форматы сообщений: "No charge required", "<XXX> USD (including VAT <YYY> USD) successfully charged", "Order not payed - not enough money at account". |
Error: Unavailable Domain Name | Домен уже зарегистрирован или регистрация домена недоступна по иным причинам. |
Error: Registraion via the system unavailable in this TLD | Регистрация в данной зоне в данный момент недоступна через систему регистрации RegRuSRS. |
Error: Invalid name servers | Указанные DNS-сервера не верны (например, указан всего один DNS-сервер или сервера не зарегистрированы в базе NSI-registry). |
Error: Domain already ordered | Заявка на регистрацию этого домена уже присутствует в системе. Повторная заявка на одно и то же имя не допускается. |
Error: Not enough money for operation | Недостаточно денег на балансе для выполнения операции. При установленном флаге "extended_message_lang" возвращается также дополнительный комментарий в формате "<XXX> USD needed". |
Эта операция позволяет подать заявку на продление регистрации домена.
В качестве значения параметра action для этой операции должно
быть указано domain_renew.
Ниже перечислены дополнительные поля, которые наряду с
общими обязательными полями
требуются для этой операции.
Имя поля | Мин. длина | Макс. длина | Описание поля |
---|---|---|---|
period | 1 | 2 | Период продления регистрации домена. Для доменов .ru и .su единственное допустимое значение: 1, для прочих доменов интервал допустимых значений: 1 - 10. Заявка на продление домена .ru или .su может быть подана не ранее чем за два месяца до окончания делегирования домена. |
Кроме общих сообщений об ошибках HTTP-шлюз может возвращать один из следующих ответов:
Ответ системы | Описание |
---|---|
Success: Renewed <domain name> for <years> years |
Заявка на продление домена успешно принята. При установленном флаге "extended_message_lang" возвращаются дополнительные комментарии о том, достаточно ли средств на лицевом счёте для выполнения операции. Возможные форматы сообщений: "<XXX> USD (including VAT <YYY> USD) successfully charged", "Order not payed - not enough money at account". |
Эта операция позволяет проверить доступность доменного имени для
регистрации.
В качестве значения параметра action для этой операции должно
быть указано domain_check.
Дополнительных полей кроме общих обязательных полей
для этой операции не требуется.
Кроме общих сообщений об ошибках HTTP-шлюз может возвращать один из следующих ответов:
Ответ системы | Описание |
---|---|
Success: <domain name> is Available | Домен доступен для регистрации. |
Success: <domain name> is Unavailable | Домен НЕ доступен для регистрации. |
Эта операция позволяет получить данные WHOIS домена.
В качестве значения параметра action для этой операции должно
быть указано domain_whois.
Дополнительных полей кроме
общих обязательных полей
для этой операции не требуется.
Кроме общих сообщений об ошибках HTTP-шлюз может возвращать один из следующих ответов:
Ответ системы | Описание |
---|---|
Error: <domain name> not found | Домен не существует или информация WHOIS по этому домену ещё не доступна. |
<raw whois data> | Текст с данными WHOIS, возвращаемый в формате HTML. Этот текст может быть без предварительной обработки включён в любую web-страницу без риска нарушения форматирования страницы. |
Эта операция позволяет сменить список DNS-серверов домена, находящегося под Вашим управлением. В качестве значения параметра action для этой операции должно быть указано domain_update_nss.
Важно: Как минимум два DNS-сервера должно быть указано. Максимальное количество DNS-серверов — 4. Если имена хостов DNS-серверов содержат имя самого домена (например, домен example.com обслуживается на DNS-серверах ns1.example.com и ns2.example.com), то для этих серверов обязательно должны быть указаны IP-адреса.
Ниже перечислены дополнительные поля, которые наряду с общими обязательными полями
Имя поля | Мин. длина | Макс. длина | Описание поля |
---|
Кроме общих сообщений об ошибках HTTP-шлюз может возвращать один из следующих ответов:
Ответ системы | Описание |
---|---|
Success: Redelegated <domain name> to <name server list> | Домен успешно переделегирован на новые сервера имён |
Error: Invalid name servers | Сервера имён не существуют или указаны неверно |
Эта операция позволяет изменить контактные данные владельца домена.
В качестве значения параметра action для этой операции должно
быть указано domain_update_contacts.
Имя поля | Мин. длина | Макс. длина | Описание поля |
---|
Имя поля | Мин. длина | Макс. длина | Описание поля |
---|
Кроме общих сообщений об ошибках HTTP-шлюз может возвращать один из следующих ответов:
Ответ системы | Описание |
---|---|
Success: Modified contact details for <domain name> | Операция произведена успешно |
Эта операция позволяет получить статус ручной проверки данных владельца домена
(для доменов .RU и .SU).
В качестве значения параметра action для этой операции должно
быть указано domain_get_approval_status.
Кроме общих сообщений об ошибках HTTP-шлюз может возвращать следующий ответов:
Ответ системы | Описание |
---|---|
Success: Domain approval status is '<status>' |
Код статуса ручной проверки домена.
Возможные коды статуса:
|
Эта операция позволяет передать права на управление доменом другому пользователю.
В качестве значения параметра action для этой операции должно
быть указано domain_partcontrol_grant.
Ниже перечислены дополнительные поля, которые наряду с
общими обязательными полями
требуются для этой операции.
Имя поля | Мин. длина | Макс. длина | Описание поля |
---|---|---|---|
newlogin | 4 | 32 | Имя логина другого пользователя в системе, которому необходимо дать права на управление доменом |
Кроме общих сообщений об ошибках HTTPS-шлюз может возвращать следующий ответов:
Ответ системы | Описание |
---|---|
Success: Domain's management rights successfully granted to '<account>' | Права на управление доменом переданы на аккаунт |
Error: no newlogin given | Значение поля newlogin не указано |
Error: login '<newlogin>' not found | Пользователь с указанным логином не найден |
Эта операция позволяет отменить права на управление доменом другим пользователем.
В качестве значения параметра action для этой операции должно
быть указано domain_partcontrol_revoke.
Кроме общих сообщений об ошибках HTTPS-шлюз может возвращать следующий ответов:
Ответ системы | Описание |
---|---|
Success: Domain managment rights successfully revoked from another users | Права на управление доменом были отменены для другого аккаунта |
Эта операция позволяет получить информацию(статус домена, дата
регистрации, дата удаления, дата условного продления) о домене
пользователя.
В качестве значения параметра action для этой операции должно
быть указано domain_get_info.
Кроме общих сообщений об ошибках HTTPS-шлюз может возвращать следующий ответов:
Ответ системы | Описание |
---|---|
state: <state> creation_date: <YYYY-MM-DD> expiration_date: <YYYY-MM-DD> future_periods: <years>; |
Статусы доменов:
|
Эта операция позволяет получить контактную информацию владельца домена.
В качестве значения параметра action для этой операции должно
быть указано domain_get_contacts.
Кроме общих сообщений об ошибках HTTPS-шлюз может возвращать следующий ответов:
Ответ системы | Описание |
---|---|
<field1>: <value1>; <field2>: <value2>; ..... <fieldN>: <valueN>; |
Поля контактной информации домена в формате: поле: значение |
Эта операция позволяет получить список DNS-серверов Вашего домена.
В качестве значения параметра action для этой операции должно
быть указано domain_get_nss.
Кроме общих сообщений об ошибках HTTPS-шлюз может возвращать следующий ответов:
Ответ системы | Описание |
---|---|
Success: <ns1.hostname>, <ns2.hostname>, ... |
Список DNS-серверов домена, разделённый запятыми |
Далее описаны различные операции по обслуживанию / изменению настроек зоны домена, которые могут быть осуществлены через HTTPS-шлюз.
Эта операция позволяет добавить для указанного домена / поддомена
DNS-запись тип записи A, MX, CNAME, NS, TXT, SRV
В качестве значения параметра action для этой операции должно
быть указано zone_add_rr.
Ниже перечислены дополнительные поля, которые наряду с общими обязательными полями
Имя поля | Мин. длина | Макс. длина | Описание поля |
---|---|---|---|
subname | 2 | 50 | Имя поддомена. Для изменения записи основного домена указывать "@" | rectype | 1 | 5 | Тип ресурсной записи. Допустимые значения: A, MX, NS, CNAME, TXT, SRV. |
Для записи типа A | |||
ipaddr | 8 | 16 | IP-адрес |
Для записи типа CNAME | |||
hostname | 2 | 50 | Canonical name |
Для записи типа MX | |||
hostname | 2 | 50 | Почтовый сервер |
priority | 1 | 2 | Приоритет записи |
Для записи типа NS | |||
hostname | 2 | 50 | DNS сервер |
Для записи типа TXT | |||
text | 1 | 253 | Текст |
Для записи типа SRV | |||
nsnum | 1 | 1 | номер NS сервера |
service | 1 | 253 | Название сервиса |
target | 1 | 253 | Target |
port | 1 | 6 | Порт |
weight | 1 | 2 | Вес |
Кроме общих сообщений об ошибках HTTPS-шлюз может возвращать один из следующих ответов:
Ответ системы | Описание |
---|---|
Success: Record added | Запись добавлена. |
Error: Uninplemented rectype | некорректный или неподдерживаемый тип записи |
Error: Invalid subdomain | Был введен некорректный поддомен |
Error: Incorrect IP | Был введен некорректный IP адрес (для записей A) |
Error: Conflict with CNAME record | Для одного поддомена нельзя указывать записи CNAME совместно с другими записями (для записей кроме CNAME) |
Error: Invalid hostname | Некорректное имя хоста (для записей CNAME, MX, NS). |
Error: CNAME conflict with other record | Для одного поддомена нельзя указывать записи CNAME совместно с другими записями (для записей CNAME) |
Error: Incorrect text | Введенный текст некорректной длины (для записей TXT) |
Error: incorrect symbols in Service | Были переданы некорректные данные в поле service (для записей SRV) |
Error: Incorrect port | Были переданы некорректные данные в поле port (для записей SRV) |
Error: Incorrect target | Были переданы некорректные данные в поле target (для записей SRV) |
Error: Incorrect weight | Были переданы некорректные данные в поле weight (для записей SRV) |
Эта операция позволяет удалить запись зоны
В качестве значения параметра action для этой операции должно
быть указано zone_rm_rr.
Ниже перечислены дополнительные поля, которые наряду с общими обязательными полями
Имя поля | Мин. длина | Макс. длина | Описание поля |
---|---|---|---|
subname | 2 | 50 | Имя поддомена |
rectype | 2 | 10 | Тип записи |
misc | 1 | 6 | Приоритет |
Кроме общих сообщений об ошибках HTTPS-шлюз может возвращать один из следующих ответов:
Ответ системы | Описание |
---|---|
Success: Record removed | Запись удалена |
Success: Record not found | Запись не найдена |
Эта операция позволяет обновить зону на DNS-серверах (обновить запись SOA).
В качестве значения параметра action для этой операции должно
быть указано zone_update.
Никаких дополнительных параметров она не требует.
Кроме общих сообщений об ошибках HTTPS-шлюз может возвращать один из следующих ответов:
Ответ системы | Описание |
---|---|
Success: Zone updated | Обновление зоны инициировано. |
Error: Can't update zone | Невозможно обновить зону. Возможно, домен не активен (не оплачен или заблокирован). |
Эта операция позволяет настроить зону для парковки
В качестве значения параметра action для этой операции должно
быть указано zone_tune_park.
Никаких дополнительных параметров она не требует.
Кроме общих сообщений об ошибках HTTPS-шлюз может возвращать один из следующих ответов:
Ответ системы | Описание |
---|---|
Success: Zone updated | Обновление зоны инициировано. |
Эта операция позволяет настроить зону для хостинга
В качестве значения параметра action для этой операции должно
быть указано zone_tune_host.
Никаких дополнительных параметров она не требует.
Кроме общих сообщений об ошибках HTTPS-шлюз может возвращать один из следующих ответов:
Ответ системы | Описание |
---|---|
Success: Zone updated | Обновление зоны инициировано. |
Эта операция позволяет получить информацию о зоне
В качестве значения параметра action для этой операции должно
быть указано zone_get_info.
Никаких дополнительных параметров она не требует.
Кроме общих сообщений об ошибках HTTPS-шлюз может возвращать один из следующих ответов:
Ответ системы | Описание |
---|---|
RRs subname: <subname>;priority: <priority>;address: <address>;rectype: <rectype>; subname: <subname>;priority: <priority>;address: <address>;rectype: <rectype>; .... subname: <subname>;priority: <priority>;address: <address>;rectype: <rectype>; SRV service: <service>;rectype: <rectype>;priority: <priority>;weight: <weight>;port: <port>;target: <target>; |
RRs вывод ресурсных данных зоны SRV вывод srv записей зоны |
Далее описаны различные операции по обслуживанию / изменению настроек доменов, которые могут быть осуществлены через HTTP-шлюз.
Эта операция позволяет получить информацию о размере предоплаты находящейся на счету пользователя.
В качестве значения параметра action для этой операции должно
быть указано balance_get.
Кроме общих сообщений об ошибках HTTPS-шлюз может возвращать следующий ответов:
Ответ системы | Описание |
---|---|
Success: account balance is <balance> USD without VAT | Баланс пользователя в у. е. (без НДС) |
Эта операция позволяет выписать счёт на предоплату (для пополнения баланса). В качестве значения параметра action для этой операции должно быть указано balance_refill. В настоящее премя поддерживается только пополнение баланса по WebMoney.
Ниже перечислены дополнительные поля, которые наряду с общими обязательными полями
Имя поля | Мин. длина | Макс. длина | Описание поля |
---|---|---|---|
pay_type | 2 | 20 | Способ оплаты счёта. В настоящее время поддерживается только WebMoney (значение поля — "WM") |
amount | 1 | 6 | Сумма предоплаты в у.е. (указывается без НДС) |
Поля для способа оплаты "WM" | |||
wmid | 12 | 12 | WMID плательщика для выписки WM-счёта |
Кроме общих сообщений об ошибках HTTPS-шлюз может возвращать следующий ответов:
Ответ системы | Описание |
---|---|
Success: account balance is <balance> USD without VAT | Баланс пользователя в у. е. (без НДС) |
Ссылки на HTML-формы, иллюстрирующие HTTP-запросы к шлюзу RegRuSRS даны в третьей колонке таблицы операций, приведённой в разделе 3.1 (список операций).
Внимание! Не устанавливайте для Ваших клиентов web-формы, содержащие Ваши авторизационные данные, т.к. клиенты могут легко узнать Ваш login и пароль. Для обеспечения безопасности, запросы должны отправляться программой на стороне сервера.