Содержание

	1. Введение 1.1. Преимущества API 2.0 по сравнению с API 1.0 1.2. Рекомендации по эффективному взаимодействию с API 2. Общее описание REG.API 2.0 2.1. Общий принцип взаимодействия 2.2. Формат запроса 2.2.1. Виды входных параметров 2.2.2. Передача входных параметров (форматы данных) 2.2.3. Форматы входных параметров 2.2.4. Общие входные параметры 2.2.4.1. Параметры для аутентификации 2.2.4.2. Параметры для управления работой API 2.2.4.3. Параметры для идентификации услуги 2.2.4.4. Параметры для идентификации списка услуг 2.2.4.5. Параметры для идентификации папки 2.2.4.6. Параметры оплаты 2.3. Формат ответа 2.3.1. Передача выходных параметров (форматы данных) 2.3.2. Общие выходные параметры 2.3.3. Общие коды ошибок 2.4. Аутентификация 2.4.1. Аутентификация по паролю 2.5. Тестовый и боевой режим 3. Общее описание функций 3.1. Виды функций 3.2. Доступность функций 3.3. Список функций 4. Функции общего назначения 4.1. nop (ничегонеделание) 4.2. reseller_nop (nop для партнеров) 4.3. get_user_id (получение идентификатора авторизованного пользователя) 4.4. get_service_id (получение id домена или услуги) 5. Функции для работы с учётной записью 5.1. user/nop (проверка доступности) 5.2. user/create (регистрация нового пользователя) 5.3. user/get_statistics (получение статистики) 5.4. user/get_balance (просмотр суммы на счету) 5.5. user/refill_balance (пополнение баланса) 6. Функции для работы со счетами 6.1. bill/nop (проверка доступности) 6.2. bill/get_not_payed (список неоплаченных счетов) 6.3. bill/get_for_period (список счетов за указанный период) 6.4. bill/change_pay_type (изменение способа оплаты) 6.5. bill/delete (удаление счета) 7. Функции для работы с доменами 7.1. domain/nop (тестовая функция) 7.2. domain/get_prices (получить цены на все доменные зоны) 7.3. domain/get_suggest (подбор имени для домена по ключевым словам) 7.4. domain/get_premium (возвращает список доступных к регистрации премиум-доменов) 7.5. domain/check (проверка занятости домена) 7.6. domain/create (заявка на регистрацию домена) 7.7. domain/transfer (заявка на перенос домена) 7.8. domain/get_rereg_data (список освобождающихся доменов с характеристиками) 7.9. domain/set_rereg_bids (сделать ставки на освобождающиеся домены) 7.10. domain/get_user_rereg_bids (список освобождающихся доменов со своими ставками) 7.11. domain/get_docs_upload_uri (получение ссылки на закачивание документов) 7.12. domain/update_contacts (изменение контактных данных домена) 7.13. domain/update_private_person_flag (изменение флага скрытия/отображения контактных данных в whois) 7.14. domain/register_ns (внесение домена в NSI-registry) 7.15. domain/delete_ns (удаление домена из NSI-registry) 7.16. domain/get_nss (получение списка DNS для доменов) 7.17. domain/update_nss (изменение DNS серверов домена) 7.18. domain/delegate (делегирование домена) 7.19. domain/undelegate (снятие делегирования домена) 7.20. domain/transfer_to_another_account (передача домена на другой аккаунт) 7.21. domain/look_at_entering_list (просмотр передаваемых на аккаунт доменов) 7.22. domain/accept_or_refuse_entering_list (принять или отклонить передаваемые на аккаунт домены) 7.23. domain/cancel_transfer (отменить перенос домена) 8. Функции для управления DNS-зоной 8.1. zone/nop (проверка доступности управления DNS-зоной) 8.2. zone/add_alias (cвязать поддомен с IP-адресом) 8.3. zone/add_aaaa (cвязать поддомен с IPv6-адресом) 8.4. zone/add_cname (cвязать поддомен с адресом другого домена) 8.5. zone/add_mx (назначить обслуживающий почтовый сервер) 8.6. zone/add_ns (добавить запись ns) 8.7. zone/add_txt (добавить запись txt) 8.8. zone/add_srv (добавить запись srv) 8.9. zone/get_resource_records (получение ресурсных записей зоны) 8.10. zone/update_records (добавление и/или удаление нескольких ресурсных записей одним запросом) 8.11. zone/update_soa (изменить время жизни кеша для зоны) 8.12. zone/tune_forwarding (добавить ресурсные записи для web-форвардинга) 8.13. zone/clear_forwarding (удалить ресурсные записи, необходимые для web-форвардинга) 8.14. zone/tune_parking (добавить ресурсные записи для парковки) 8.15. zone/clear_parking (удалить ресурсные записи для парковки) 8.16. zone/remove_record (удалить одну ресурсную запись) 8.17. zone/clear (удалить все ресурсные записи) 9. Функции для работы с услугами 9.1. service/nop (проверка доступности списка услуг) 9.2. service/get_servtype_details (получить цену и общие данные услуги) 9.3. service/create (заказ новой услуги) 9.4. service/delete (удаление услуги) 9.5. service/get_info (получить информацию об услугах) 9.6. service/get_list (получить список активных услуг) 9.7. service/get_folders (получение списка папок, в которые входит сервис) 9.8. service/get_details (получение общей информации по услуге) 9.9. service/service_get_details 9.10. service/get_dedicated_server_list (получение списка выделенных серверов доступных для заказа) 9.11. service/update (настройка услуги) 9.12. service/renew (продление домена или услуги) 9.13. service/get_bills (получить список счетов, связанных с услугами) 9.14. service/set_autorenew_flag (управление флагом автопродления) 9.15. service/suspend (приостановить действие услуги) 9.16. service/resume (возобновить действие услуги) 9.17. service/get_depreciated_period (число периодов до даты истечения услуги) 9.18. service/upgrade (повышение тарифа услуги) 9.19. service/partcontrol_grant (передать услугу в частичное управление) 9.20. service/partcontrol_revoke (отозвать права частичного управления) 10. Функции для работы с папками 10.1. folder/nop (тестирование, проверка существования папки) 10.2. folder/create (создание папки) 10.3. folder/remove (удаление папки) 10.4. folder/rename (переименование папки) 10.5. folder/get_services (получить список услуг в папке) 10.6. folder/add_services (добавление услуг в папку) 10.7. folder/remove_services (удаление услуг из папки) 10.8. folder/replace_services (перезаписать услуги в папке) 10.9. folder/move_services (перенос услуг из одной папки в другую)

1. Введение

Для повышения удобства технического взаимодействия клиентов и партнёров компании «Регистратор доменных имён REG.RU» с распределённой системой регистрации (далее RegRuSRS) был реализован простой и доступный программный интерфейс — REG.API, работающий поверх протокола HTTP. Мы думаем, что использование REG.API делает наше техническое взаимодействие с клиентами и партнёрами более эффективным.

Данное руководство описывает интерфейс доступа к REG.API второй версии, являющейся развитием API предыдущих версий, и предназначено для программистов, автоматизирующих взаимодействие с RegRuSRS.

Предполагается, что читатель знаком с основами HTTP и имеет навыки программирования. Технические вопросы не отражённые в данном документе можно задать здесь.

1.1. Преимущества API 2.0 по сравнению с API 1.0

1. Унифицированная передача сложных структур данных.
2. Большая гибкость в выборе форматов передачи данных: возможность передачи входных параметров в форматах plain HTTP, JSON или XML, выходных — в виде JSON, YAML, XML или plain text.
3. Возможность параллельного выполнения нескольких операций одним пользователем.
4. Возможность работы с различными кодировками (по умолчанию utf8; также поддерживаются cp1251, koi8-r, koi8-u, cp866).
5. Многоязычные варианты ответов системы.
6. Выдача расширенной информации об ошибках.
7. Унифицированный способ идентификации доменов и услуг, с которыми производится операция.
8. Различные способы идентификации услуг: кроме имени домена, теперь вы можете использовать наши идентификаторы услуг в системе, которые позволяют всегда точно и легко указать нужную услугу.
9. Расширенные возможности отладки: различные тестовые функции, возможность просмотра входных параметров (с целью контроля правильности их передачи и декодирования).
10. Возможность выставлять в поле Content-type в ответах системы любое удобное для Вас значение.
11. Большая часть функций доступна и обычным пользователям! Вам необязательно быть партнёром!

Презентация по преимуществам API 2.0.

1.2. Рекомендации по эффективному взаимодействию с API

За время более чем двухлетней эксплуатации REG.API был накоплен значительный опыт технического взаимодействия с партнёрами, выявлены типичные проблемы взаимодействия.

Одной из проблем, с которой сталкиваются партнёры, является превышение лимита запросов к REG.API (1200 запросов в час).

Анализ подобных ситуаций позволяет однозначно заключить, что проблема в подобных случаях заключается в неправильном / нецелевом использовании API в связи с ошибками либо архитектурными просчётами в программном обеспечении на стороне партнёров.

Считаем своим долгом дать ряд практических советов, которые позволят, с одной стороны, уменьшить вероятность превышения допустимого количества запросов к REG.API и следующего за этим временного блокирования операций партнёра и, с другой стороны, снизить нагрузку на систему регистрации RegRuSRS.

1. Рекомендуем осуществлять WHOIS-запросы по доменам (для отображения информации WHOIS на Ваших сайтах) не через REG.API, а обращаясь напрямую к WHOIS-серверам соответствующих доменных зон.

   При этом Вы получаете следующие преимущества:
   а) ответ на WHOIS-запрос будет получен Вами быстрее,
   б) предлагаемая схема более надёжна, поскольку исключаются лишние звенья,
   в) уменьшается вероятность блокировки при превышении лимита запросов к API за счёт сокращения общего количества API-запросов.

   Мы предлагаем готовые программные решения, которые могут облегчить Ваши трудозатраты перехода на правильную схему реализации функционала для осуществления WHOIS-запросов.

2. Рекомендуем обращаться к API только для совершения заказов / изменения данных, но не для получения информации. Программное обеспечение некоторых наших партнёров либо не хранит, либо хранит неполную информацию о доменах в локальной базе данных. В результате эта информация очень часто динамически скачивается с нашей системы регистрации через функции domain_list, service/get_info, domain/get_contacts, domain/get_nss и т. п.
   Рекомендуем хранить полную информацию о доменах и услугах локально и обращаться к REG.API только при необходимости изменения информации в реестре. В этом случае Ваша система будет работать быстрее и надёжнее, будет меньше зависеть от доступности нашей системы регистрации с Вашего сервера.

3. Рекомендуем выполнять все запросы на изменение данных асинхронно.

   Программное обеспечение некоторых наших партнёров осуществляет операции по регистрации доменов и услуг и изменению данных непосредственно в момент обработки HTTP-запроса от клиента. При этом если API-запрос не выполняется по каким-либо причинам сразу (отсутствие связи, превышение лимита запросов, блокировки параллельных запросов), то соответствующий запрос фактически теряется и клиент партнёра получает сообщение об ошибке.

   Подобная схема взаимодействия является крайне ненадёжной и в конечном итоге неудобной для Ваших клиентов.

   Рекомендуем осуществлять все запросы по заказу услуг / изменению данных асинхронно, через механизм очередей. В этом случае:
   а) исключаются блокировки API-запросов (параллельно выполняется только один API-запрос, поскольку очередь можно обрабатывать в один поток);
   б) в случае отсутствия связи запрос может повторяться, пока он не будет выполнен (таким образом существенно увеличивается надёжность системы);
   в) в случае ошибок при обработке запросов (если REG.API вернул код ошибки) партнёр может решить проблему и повторить заявку, при этом клиент не получает лишних сообщений об ошибках — большинство проблем могут решаться партнёром самостоятельно, без ведома и участия клиента.

4. Рекомендуем выполнять на Вашей стороне логирование всех API-запросов и ответов. При этом в случае возникновения каких-либо проблем в процессе взаимодействия наличие журнала позволит гораздо эффективнее диагностировать проблемы на Вашей стороне, а также более грамотно обращаться в нашу службу технической поддержки, приводя выдержки из журналов, описывающие проблему.

Надеемся, что данная информация может быть для Вас полезной и позволит улучшить качество нашего технического взаимодействия.

2. Общее описание REG.API 2.0

2.1. Общий принцип взаимодействия

Транспортным протоколом для вызова функций REG.API является HTTP (HTTPS). В REG.API поддерживаются как GET, так и POST запросы. Однако рекомендуемым является метод POST, т.к. он не имеет ограничений на длину запроса.

Каждый вызов является атомарным и синхронным, то есть все запросы независимы друг от друга. Также все операции являются синхронными: результат операции возвращается сразу же, нет промежуточных состояний при выполнении операции. Выбор в пользу такого способа взаимодействия был сделан для удобства подключения к REG.API со стороны клиентов.

2.2. Формат запроса

URL для вызова функций выглядит следующим образом:

Таким образом, для каждой функции имеем собственный URL для её вызова (в API 1.0 URL для всех функций был одинаковым, а вызываемая функция идентифицировалась с помощью параметра action).

Практически все функции требуют дополнительных параметров для своего вызова.

2.2.1. Виды входных параметров

Передаваемые параметры можно разделить на несколько категорий:

• параметры аутентификации;
• параметры идентификации услуги;
• параметры управления работой API;
• параметры, специфичные для конкретной функции.

Из перечисленных четырех видов входных параметров обязательными практически для всех функций являются параметры аутентификации. Конкретный набор необходимых параметров варьируется от функции к функции и документирован в описании конкретных функций.

2.2.2. Передача входных параметров

Все дополнительные параметры, если они есть, можно передавать в виде стандартных HTTP-параметров GET или POST, где передаваемые данные кодируются как x-www-form-urlencoded.

Пример передачи параметров через GET запрос:

Параметры функции также можно передавать в форматах JSON или XML В этом случае все параметры, сериализованные в строку, передаются как один HTTP-параметр через поле input_data.

Пример передачи сериализованных параметров через запрос GET:

Пример вызова со сложной структурой можно посмотреть, например, в описании функции set_rereg_bids.

При необходимости передачи сложных структур данных использование JSON и XML — единственный способ их передать.

2.2.3. Форматы входных параметров

Передача данных возможна в нескольких форматах: как простые параметры HTTP-запроса (GET/POST), который далее условно будет называться «PLAIN», так и JSON и XML. Для наглядности их лучше рассмотреть на примерах передачи данных с ответом в JSON и выводом всех полученных данных, дополнительно указав для этого входной параметр show_input_params=1. Чтобы показать возможность передачи списка данных, в запрос добавлен список leftdata, не несущий никакой функциональности.

2.2.3.1. Формат «PLAIN» (простые параметры HTTP)

Поля input_format и input_data

отсутствуют

Пример запроса:

https://api.reg.ru/api/regru2/domain/nop?username=test&password=test&output_content_type=plain&show_input_params=1&domain_name=qqq.ru&leftdata=1&leftdata=2&leftdata=3

Пример успешного ответа:

{
   "input_params" : {
      "show_input_params" : "1",
      "output_content_type" : "plain",
      "domain_name" : "qqq.ru",
      "password" : "test",
      "leftdata" : [
         "1",
         "2",
         "3"
      ],
      "username" : "test"
   },
   "answer" : {
      "service_id" : "123456"
   },
   "result" : "success"
}

2.2.3.2. Формат JSON

Значение поля input_format

json

Пример запроса:

https://api.reg.ru/api/regru2/domain/nop?username=test&password=test&input_format=json&input_data={"output_content_type":"plain","show_input_params":1,"domain_name":"qqq.ru","leftdata":[1,2,3]}

Пример успешного ответа:

{
   "input_params" : {
      "domain_name" : "qqq.ru",
      "show_input_params" : "1",
      "output_content_type" : "plain",
      "password" : "test",
      "input_format" : "json",
      "leftdata" : [
         "1",
         "2",
         "3"
      ],
      "username" : "test",

   },
   "answer" : {
      "service_id" : "123456"
   },
   "result" : "success"
}

2.2.3.3. Формат XML

Значение поля input_format

xml

Пример запроса:

https://api.reg.ru/api/regru2/domain/nop/username=test&password=test&input_format=xml&input_data=<opt domain_name="regrutestuser.ru" output_content_type="plain" show_input_params="1"><leftdata>1</leftdata><leftdata>2</leftdata><leftdata>3</leftdata></opt>

Пример успешного ответа:

{
   "input_params" : {
      "domain_name" : "qqq.ru",
      "show_input_params" : "1",
      "output_content_type" : "plain",
      "password" : "test",
      "input_format" : "xml",
      "leftdata" : [
         "1",
         "2",
         "3"
      ],
      "username" : "test",

   },
   "answer" : {
      "service_id" : "123456"
   },
   "result" : "success"
}

2.2.4. Общие входные параметры

Конкретный набор необходимых параметров варьируется от функции к функции, однако часть параметров применима ко всем или к большинству функций. Эти параметры описаны в данном разделе.

2.2.4.1. Параметры для аутентификации

Эти параметры являются необходимыми для функций, требующих аутентификации. Это поля username + password либо username + signature (выбор варианта зависит от используемого способа авторизации).

2.2.4.2. Параметры для управления работой API.

К дополнительным параметрам можно отнести общие параметры управления работой API и параметры идентификации услуги.

К общим параметрам управления работой API относятся функции управления форматом входных и выходных параметров функции, выбора рабочей кодировки и языка.

2.2.4.3. Параметры для идентификации услуги

Параметры идентификации услуги требуются при выполнении операций над конкретной ранее заказанной услугой, когда её надо сначала идентифицировать.

Возможны следующие варианты идентификации:

1. по ID услуги (как для доменов так и для услуг),
2. по имени домена (для доменов),
3. по имени домена и типу услуги (для услуг),
4. по ID родительской услуги, типу услуги и подтипу услуги (для услуг).

Наиболее точной и быстрой является идентификация по числовому идентификатору услуги, поэтому мы рекомендуем хранить на своей стороне и использовать ID домена/услуги и при вызовах передавать идентификатор услуги.

2.2.4.4. Параметры для идентификации списка услуг

В общем виде input_data в формате JSON для такого запроса выглядит так:

Ответ при запросе со списком услуг будет так же содержать список и для каждой услуги будет указан результат в поле result. В случае успеха это будет success, в случае ошибки — текст самой ошибки, а так же поле error_code со стандартным кодом ошибки, совпадающим с кодом при запросе 1 домена.

Пример: получение service_id услуг используя service/nop с ошибками в двух последних значениях

{
   "answer" : {
      "services" : [
         {
            "dname" : "test.ru",
            "service_id" : "12345",
            "servtype" : "domain",
            "result" : "success"
         },
         {
            "dname" : "test.su",
            "service_id" : "12346",
            "servtype" : "srv_hosting_ispmgr",
            "result" : "success"
         },
         {
            "dname" : "test12347.ru",
            "service_id" : "111111",
            "servtype" : "domain",
            "result" : "success"
         },
         {
            "service_id" : "22bug22",
            "result" : "service_id is invalid",
            "error_code" : "INVALID_SERVICE_ID"
         },
         {
            "surprise" : "surprise.ru",
            "result" : "domain_name not given or empty",
            "error_code" : "NO_DOMAIN"
         }
      ]
   },
   "result" : "success"
}

Ниже, при детальном описании каждой функции, будет указана поддержка обработки списка услуг

2.2.4.5. Параметры для идентификации папки

В данном разделе описаны способы идентификации папок.

Наиболее точной и быстрой идентификацией папок является идентификация по числовому идентификатору папки folder_id, поэтому мы рекомендуем хранить на своей стороне и использовать ID папки и при вызовах передавать числовой идентификатор папки.

2.2.4.6. Параметры оплаты

В данном разделе описаны общие параметры для функций, связанных с заказом или продлением услуг, т. е. функций, которые задействуют оплату.

2.3. Формат ответа

2.3.1. Передача выходных параметров

Все функции могут возвращать ответы в форматах JSON, YAML, XML и plain text. По умолчанию используется JSON. Выходной формат передачи данных переключается с помощью опции output_format.

Некоторые функции имеют дополнительные форматы вывода, помимо перечисленных. Например, функция get_rereg_data может отдавать данные в CSV формате.

2.3.1.1. Формат JSON

Значение поля output_format

json

Примеры запросов:

https://api.reg.ru/api/regru2/nop
https://api.reg.ru/api/regru2/nop&output_format=json

Пример ответа с возвратом ошибки:

{
   "error_text" : "No username given",
   "result" : "error",
   "error_code" : "NO_USERNAME"
}

2.3.1.2. Формат YAML

Значение поля output_format

yaml

Пример запроса:

https://api.reg.ru/api/regru2/nop?output_format=yaml

Пример ответа с возвратом ошибки:

---
error_code: NO_USERNAME
error_text: No username given
result: error

2.3.1.3. Формат XML

Значение поля output_format

xml

Пример запроса:

https://api.reg.ru/api/regru2/nop?output_format=xml

Пример ответа с возвратом ошибки:

<opt error_code="NO_USERNAME" error_text="No username given" result="error" />

2.3.1.4. Формат «PLAIN»

В данном формате ответ возвращается в упрощённом виде: не возвращаются сложные / вложенные структуры данных. В связи с данным ограничением не рекомендуется использовать этот формат.

Значение поля output_format

plain

Пример запроса:

https://api.reg.ru/api/regru2/nop?output_format=plain

Пример ответа с возвратом ошибки:

error; NO_USERNAME; No username given

2.3.2. Общие выходные параметры

Все ответы API функций (как ошибки, так и успешные ответы) стандартизованы.

Обязательным полем для любого ответа является result. Оно может иметь значения "error" или "success".

Поля, присутствующие в положительном ответе:

Пример положительного ответа:

{
    'answer' => {
        'user_id' => '0',
        'login'   => 'test'
    },
    'result' => 'success'
}

Поля, возвращаемые в случае ошибки:

Пример ответа, возвращающего ошибку:

{
    'error_text' => 'Username/password Incorrect',
    'error_code' => 'PASSWORD_AUTH_FAILED',
    'result'     => 'error'
}

2.3.3. Общие коды ошибок

2.4. Аутентификация

Для доступа к большей части API функций требуется проведение аутентификации.
Возможны следующие способы:

• По логину и паролю.

2.4.1. Аутентификация по паролю

Для доступа по логину/паролю оба поля передаются в явном виде как значения для username, password:

Вследствие того что в этом способе аутентификации логин и пароль передаются в явном виде, лучше избегать им пользоваться, особенно при использовании HTTP-протокола, т.к. в этом случае пароль легко может быть перехвачен.

Список полей с описанием, используемых для аутентификации, перечислен в разделе «Параметры для аутентификации».

.

Возможные ошибки аутентификации см. в стандартных кодах ошибок

2.5. Тестовый и рабочий (боевой) доступ к REG.API

Для отладки работы с API предусмотрен тестовый доступ; для этого имя пользователя и пароль должны иметь значение «test».
При таком режиме работы осуществляются все проверки входных параметров, выдаётся ответ, но никаких действий не производится, и деньги за операции не снимаются. Ответ сервера при работе в тестовом режиме носит ознакомительный характер, в некоторых случаях может содержать неактуальные значения и не соответствовать реальной картине, имеющей место при использовании боевого доступа. При вызове функций в тестовом режиме никаких реальных данных о доменах не возвращается.

Также для отладочных целей есть несколько специализированных функций, которые предназначены для вызовов под реальными идентификационными данными. Это nop, reseller_nop, user/nop, bill/nop, domain/nop, zone/nop, service/nop, folder/nop. Они не выполняют никаких действий, но позволяют проверить доступность системы без её дополнительной нагрузки и, соответственно, с минимальным временем отклика. Ниже каждая из этих функций описана подробнее.

3. Общее описание функций

3.1. Виды функций

Все функции API в данный момент делятся на пять видов:

1. Пользовательские функции (им соответствует относительный путь user/) предназначены для получения данных, тем или иным образом связанных с конкретным пользователем (запросы баланса, статистики регистраций и проч.).
2. Функции работы с доменами (им соответствует относительный путь domain/) позволяют производить различные манипуляции с доменами.
3. Функции работы с услугами (им соответствует относительный путь service/) содержат всё необходимое для осуществления операция с услугами.
4. Функции работы с папками (им соответствует относительный путь folder/) позволяют группировать домены и услуги по собственным критериям.
5. Несколько отладочных функций вне категорий.

В зависимости от того, какая функция Вам нужна, требуется указывать различные адреса. Общий вид адреса такой: где имя_категории может принимать значения: user, domain, service, folder.

3.1.1. Доступность функций

Все функции REG.API условно можно разделить на три категории по доступности.
Первая категория — это общедоступные функции, при вызове которых не требуется указывать username. Как правило, это функции получения общих сведений, которые не зависят от того, кто их вызвал. В нижеприведенной таблице у таких функций графа «доступность» имеет значение «все».
Другая категория — это функции требующие аутентификации, но доступные для всех клиентов, зарегистрировавшихся на нашем сайте.
Третья категория ограничена клиентами, заключившими с нами партнёрское соглашение.

3.1.2. Список функций

Здесь приведен перечень доступных функций с кратким описанием и указанием их доступности. Полное, детальное описание каждой функции с примерами использования см. ниже. Вопросы по работе функций, не отражённые в данном документе, можно задать на форуме по работе с REG.API

4. Функции общего назначения

4.1. Функция: nop

Назначение:

для тестирования, здесь — ничегонеделание + получение логина и идентификатора залогиненого пользователя

Доступность:

клиенты

Поля запроса:

нет

Поддержка обработки списка услуг

нет

Поля ответа:

Поле	Описание
login	Имя пользователя, переданное в запросе как username.
user_id	Идентификатор пользователя в системе.

Пример запроса:

https://api.reg.ru/api/regru2/nop?username=test&password=test

Пример успешного ответа:

{
    answer => {
        user_id => '0',
        login   => 'test'
    },
    result => 'success'
}

Возможные ошибки:

пример ответа с ошибкой (неверное имя пользователя / пароль)

{
    error_text => 'Username/password Incorrect',
    error_code => 'PASSWORD_AUTH_FAILED',
    result     => 'error'
}

Также см. другие cтандартные коды ошибок

4.2. Функция: reseller_nop

Назначение:

полностью аналогична функции nop за исключением двух следующих пунктов

Доступность:

партнёры

Режим доступа:

только защищённый HTTPS

Поля запроса:

нет

Поддержка обработки списка услуг

нет

Поля ответа:

Поле	Описание
login	Имя пользователя, переданное в запросе как username.
user_id	Идентификатор пользователя в системе.

Пример запроса:

https://api.reg.ru/api/regru2/reseller_nop?username=test&password=test

Возможные ошибки:

Пример ошибки, если обычный пользователь пытается получить доступ к функциям только для партнёров:

{
    error_text => 'Only resellers can access to this function',
    error_code => 'RESELLER_AUTH_FAILED',
    result     => 'error'
}

Такая ошибка будет в случае попытки доступа не по HTTPS соединению:

{
    error_text => 'Access to api over non secure interface (http) prohibited!',
    error_code => 'HTTPS_ONLY',
    result     => 'error'
}

4.3. Функция: get_user_id

Назначение:

для тестирования, возвращает идентификатор залогиненого пользователя

Доступность:

клиенты

Поля запроса:

нет

Поддержка обработки списка услуг

нет

Поля ответа:

Поле	Описание
user_id	Идентификатор пользователя в системе

Пример запроса:

https://api.reg.ru/api/regru2/get_user_id?username=test&password=test

Пример успешного ответа:

{
    answer => {
        user_id => 0,
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

4.4. Функция: get_service_id

Назначение:

получение id домена или услуги

Доступность:

клиенты

Поля запроса:

стандартные параметры идентификации сервисов

Поддержка обработки списка услуг

нет

Поля ответа:

Поле	Описание
service_id	идентификатор домена или услуги

Пример запроса:

https://api.reg.ru/api/regru2/get_service_id?username=test&password=test&domain_name=qqq.ru

Пример успешного ответа:

{
    answer => {
        service_id => '123456',
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

5. Функции для работы c учётной записью (категория user)

5.1. Функция: user/nop

Назначение:

для тестирования доступности

Доступность:

все

Поля запроса:

нет

Поддержка обработки списка услуг

нет

Поля ответа:

нет

Пример запроса:

https://api.reg.ru/api/regru2/user/nop

Пример успешного ответа:

{
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

5.2. Функция: user/create

Назначение:

регистрация нового пользователя

Доступность:

партнёры

Поля запроса:

Поле	Описание
Обязательные поля
user_login	Логин нового пользователя в системе REG.RU, допустимые символы: латинские строчные буквы от "a" до "z", цифры "0" - "9", символы "-", "_"
user_password	Пароль нового пользователя, допускается использование любых латинских символов
user_email	Адрес электронной почты нового пользователя
user_country_code	Двухбуквенный ISO-код страны проживания нового пользователя, например RU
Необязательные поля — анкета пользователя
user_first_name	Имя контактного лица
user_last_name	Фамилия контактного лица
user_company	Компания, в которой работает новый пользователь
user_jabber_id	Jabber ID нового пользователя
user_icq	ICQ UIN нового пользователя
user_phone	Номер телефона нового пользователя, телефон указывается с международном формате, например: +7.4951234567
user_fax	Номер факса нового пользователя, телефон указывается с международном формате, например: +7.4951234567
user_addr	Адрес нового пользователя: улица, дом, офис/квартира
user_city	Адрес нового пользователя: город
user_state	Адрес нового пользователя: область/край/штат
user_postcode	Почтовый индекс нового пользователя
user_wmid	Webmoney ID нового пользователя
user_website	Веб-сайт нового пользователя
Необязательные поля — другие параметры
user_subsribe	Подписать пользователя на рассылку по электронной почте от REG.RU, допустимые значения 1 или 0 значение по умолчанию 0
user_mailnotify	Послать пользователю уведомление о регистрации, допустимые значения 1 или 0, значение по умолчанию 1
set_me_as_referrer	Сделать регистрируемого пользователя рефералом регистратора, допустимые значения 1 или 0, значение по умолчанию 0
check_only	Не регистрировать пользователя, только проверить контакты, допустимые значения 1 или 0, значение по умолчанию 0, при check_only=1 в ответе будетuser_id=777

Поддержка обработки списка услуг

нет

Поля ответа:

Поле	Описание
user_id	идентификатор только что созданного пользователя

Пример запроса:

https://api.reg.ru/api/regru2/user/create?username=test&password=test&user_login=othertest&user_password=xxxxx&user_email=test@test.ru&user_country_code=RU&user_mailnotify=0&set_me_as_referrer=1

Пример успешного ответа:

{
    answer => {
        user_id => 777
    },
    result => 'success'
}

Возможные ошибки:

Error_code	Error_text	Описание
USER_LOGIN_NOT_UNIQUE	This login already is busy	Этот логин уже занят

Так же см. Стандартные коды ошибок

5.3. Функция: user/get_statistics

Назначение:

получение статистики по пользователю

Доступность:

клиенты

Поля запроса:

Поле	Описание
date_from	задать начальную дату для параметров, необязательный параметр
date_till	задать конечную дату для параметров, необязательный параметр

Поддержка обработки списка услуг

нет

Поля ответа:

Поле	Описание
costs_for_period	потрачено средств за указанный период
active_domains_cnt	кол-во активных доменов, в т.ч. полученных в частичное управление
active_domains_get_ctrl_cnt	кол-во доменов, полученных в частичное управление
renew_domains_cnt	кол-во доменов, требующих продления
renew_domains_get_ctrl_cnt	кол-во доменов, требующих продления из полученных в частичное управление
trans_in_domains_cnt	кол-во доменов, ожидающих переноса в REG.RU, если такие есть
undelegated_domains_cnt	кол-во неделегированных доменов
reg_domains_cnt	кол-во зарегистрированных доменов за период
domain_folders_cnt	кол-во доменных папок

Пример запроса:

https://api.reg.ru/api/regru2/user/get_statistics?username=test&password=test

Пример успешного ответа:

{
    answer => {
        renew_domains_get_ctrl_cnt  => 1,
        domain_folders_cnt          => 2,
        active_domains_get_ctrl_cnt => 3,
        renew_domains_cnt           => 4,
        active_domains_cnt          => 5,
        undelegated_domains_cnt     => 6,
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

5.4. Функция: user/get_balance

Назначение:

просмотр суммы на счету

Доступность:

клиенты

Поля запроса:

Поле	Описание
currency	указать валюту в которой выводится сумма, пересчёт из рублей производится по текущему курсу; доступные варианты: RUR, USD, EUR, UAH; значение по умолчанию — RUR

Поддержка обработки списка услуг

нет

Поля ответа:

Поле	Описание
currency	валюта в которую пересчитаны суммы в момент запроса
prepay	сумма предоплаты, находящаяся на счету
blocked	сумма заблокированная на счету, например, на время торгов для участия в акуционе доменов, отображается при ненулевом значении
credit	сумма предоставляемого кредита, доступно для Партнёров

Пример запроса:

https://api.reg.ru/api/regru2/user/get_balance?username=test&password=test&currency=RUR

Пример успешного ответа:

{
    answer => {
        currency => 'RUR',
        prepay   => 1000,
        credit   => 10
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

5.5. Функция: user/refill_balance

Назначение:

пополнение баланса, доступна отправка счетов на WebMoney и ЯндексДеньги

Доступность:

клиенты

Поля запроса:

Поле	Описание
pay_type	способ оплаты, варианты: WM — WebMoney, требует указания номера кошелька wmid; ymbill — ЯндексДеньги, получение счётов должно быть заранее активировано
wmid	номер кошелька WebMoney
currency	валюта пополнения счёта, для ЯднексДенег допустимо только RUR, для WebMoney — рубли RUR, доллары USD, euro EUR и гривны UAH
amount	сумма, на которую будет выписан счёт

Поддержка обработки списка услуг

нет

Поля ответа:

Поле	Описание
bill_id	номер созданного счёта
pay_type	способ оплаты счёта
payment	сумма предоплаты
total_payment	сумма с учётом конвертации валюты в рубли и дополнительных процентов за перевод денег, если они есть
currency	валюта в которую пересчитаны суммы в момент запроса
wm_invid	номер счёта в системе WebMoney, если равен 0, то возможно был сбой связи и надо перепроверить поступление счёта на предоплату

Пример запроса:

https://api.reg.ru/api/regru2/user/refill_balance?username=test&password=test&pay_type=WM&wmid=123456789012&currency=RUR&amount=1000

Пример успешного ответа:

{
    answer => {
        bill_id       => 123456,
        pay_type      => 'WM',
        payment       => 1000.00,
        total_payment => 1000.00,
        currency      => 'RUR',
        pay_notes     => 'Bill for prepay created',
        wm_invid      => 12345678
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

6. Функции для работы cо счетами (категория bill)

6.1. Функция: bill/nop

Назначение:

для тестирования

Доступность:

клиенты

Поля запроса:

Поле	Описание
bill_id	номер счёта при запросе с одиночным счётом
bills	список номеров счетов

Поддержка обработки списка счетов

да

Поля ответа:

Поле	Описание
bills	список счетов
bill_id	номер счёта
pay_status	статус оплаченности счёта, варианты статусов см. ниже

Примеры запросов:

https://api.reg.ru/api/regru2/bill/nop?username=test&password=test&bill_id=12345

https://api.reg.ru/api/regru2/bill/nop?username=test&password=test&input_format=json&input_data={"bills":["12345","12346"]}

https://api.reg.ru/api/regru2/bill/nop?username=test&password=test&input_format=json&input_data={"bills":[{"bill_id":"12345"},{"bill_id":"12346"}]}

Пример ответа:

{
    answer => {
        bills => [
            {
                bill_id    => 12345,
                pay_status => 'payed'
            },
            {
                bill_id    => 12346,
                error_code => 'BILL_ID_NOT_FOUND'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

6.2. Функция: bill/get_not_payed

Назначение:

получение списка неоплаченных счетов

Доступность:

клиенты

Поля запроса:

Поле	Описание
limit	количество позиций счётов, допустимых к выводу за 1 раз, значение по умолчанию 100, максимальное значение 1024
offset	смещение от начальной позиции, если количество счетов превышает указанный limit

Поддержка обработки списка счетов

да

Поля ответа:

Поле	Описание
bills	список счетов
bill_id	номер счёта
bill_date	дата создания счёта
currency	валюта (RUR - рубли, USD - доллары США, EUR - евро, UAH - украинские гривны)
payment	сумма счёта без процентов платёжных систем в рублях
total_payment	полная сумма к оплате в указанной Вами валюте, состоит из суммы цен услуг счёта, процентов за перевод денег в указанной системе оплаты, и процентов за конвертацию указанной валюты в рубли, если платёж осуществляется не в рублях
pay_type	способ платежа, варианты оплаты: prepay – использование предоплаты, WM – WebMoney, bank – банковский перевод, pbank – безналичный перевод через банк, yamoney & ymbill – Яндекс Деньги, mmailru – Деньги@Mail.Ru, robox – ROBOXchange, cash – Наличными в офисе, alfacard – Картой через Альфа-Банк, chronopay – Картой через ChronoPay, handybank – Handy Bank, rbkmoney – RBK-Money, osmp – Терминал QIWI (КИВИ), paypal – PayPal
pay_status	статус оплаченности счёта, здесь будут только notpayed — не оплачено
items	состав счёта
itemtype	тип позиции счёта: prepayment - предоплата, service - заказ услуги
dname	имя домена сервиса, если применимо
servtype	тип сервиса
service_id	id сервиса
action	заказ нового или продление уже имеющегося сервиса

Пример запроса:

https://api.reg.ru/api/regru2/bill/get_not_payed?username=test&password=test

Пример ответа:

{
    answer => {
        bills => [
            {
                bill_id       => 12345,
                bill_date     => '1917-10-16',
                currency      => 'RUR',
                payment       => 100.00,
                total_payment => 100.00,
                pay_type      => 'cash',
                pay_date      => null,
                pay_status    => 'notpayed',
                items => [
                    {
                        dname      => 'october.org',
                        itemtype   => 'service',
                        action     => 'new',
                        servtype   => 'domain',
                        service_id => 12345
                    },
                    {
                        dname      => 'october.org',
                        itemtype   => 'service',
                        action     => 'new',
                        servtype   => 'srv_certificate',
                        service_id => 12346
                    }
                ]
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

6.3. Функция: bill/get_for_period

Назначение:

получение списка счетов за указанный период

Доступность:

партнёры

Поля запроса:

Поле	Описание
start_date	начальная дата периода для запроса счетов в ISO формате, обязательное поле
end_date	конечное дата периода для запроса счетов в ISO формате, обязательное поле
pay_type	способ оплаты счёта, допустимые варианты см. в описании полей ответа
limit	количество позиций счётов, допустимых к выводу за 1 раз, значение по умолчанию 100, максимальное значение 1024
offset	смещение от начальной позиции, если количество счетов превышает указанный limit
all	так же показывать неактивные счета, т.е. у которых истекли сроки действия заказываемых сервисов или по которым был осуществлён возврат средств из-за невозможности выполнения заказа

Поддержка обработки списка счетов

да

Поля ответа:

Поле	Описание
bills	список счетов
bill_id	номер счёта
bill_date	дата создания счёта
currency	валюта (RUR - рубли, USD - доллары США, EUR - евро, UAH - украинские гривны)
payment	сумма счёта без процентов платёжных систем в рублях
total_payment	полная сумма к оплате в указанной Вами валюте, состоит из суммы цен услуг счёта, процентов за перевод денег в указанной системе оплаты, и процентов за конвертацию указанной валюты в рубли, если платёж осуществляется не в рублях
pay_type	способ платежа, варианты оплаты: prepay – использование предоплаты, WM – WebMoney, bank – банковский перевод, pbank – безналичный перевод через банк, yamoney & ymbill – Яндекс Деньги, mmailru – Деньги@Mail.Ru, robox – ROBOXchange, cash – Наличными в офисе, alfacard – Картой через Альфа-Банк, chronopay – Картой через ChronoPay, handybank – Handy Bank, rbkmoney – RBK-Money, osmp – Терминал QIWI (КИВИ), paypal – PayPal
pay_status	статус оплаченности счёта, возможные варианты: notpayed – счёт не оплачен, confirmed – оплата подтверждена, но деньги ещё не получены (например долгий перевод через банк), payed – оплачено, cancelled – оплата отменена на стороне платёжной системы
items	состав счёта
itemtype	тип позиции счёта: prepayment - предоплата, service - заказ услуги
dname	имя домена сервиса, если применимо
servtype	тип сервиса
service_id	id сервиса
action	заказ нового или продление уже имеющегося сервиса

Пример запроса:

https://api.reg.ru/api/regru2/bill/get_for_period?username=test&password=test&start_date=1917-10-26&end_date=1917-11-07

Пример ответа:

{
    answer => {
        bills => [
            {
                bill_id       => 12345,
                bill_date     => '1917-10-16',
                currency      => 'RUR',
                payment       => 100.00,
                total_payment => 100.00,
                pay_type      => 'cash',
                pay_date      => '1917-10-16',
                pay_status    => 'payed',
                items => [
                    {
                        dname      => 'october.org',
                        itemtype   => 'service',
                        action     => 'new',
                        servtype   => 'domain',
                        service_id => 12345
                    },
                    {
                        dname      => 'october.org',
                        itemtype   => 'service',
                        action     => 'new',
                        servtype   => 'srv_certificate',
                        service_id => 12346
                    }
                ]
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

6.4. Функция: bill/change_pay_type

Назначение:

изменение способа оплаты счёта, для некоторых способов возможно выставление счёта в указанной системе оплаты, для prepay оплата производится сразу

Доступность:

клиенты

Поля запроса:

Поле	Описание
bill_id	номер счёта при запросе с одиночным счётом
bills	список номеров счетов
pay_type	новый тип платежа, обязательное поле, возможные варианты: prepay — предоплата, оплата производится сразу; WM — WebMoney, при указании wmid выставляется эл.счёт на кошелёк клиента; yamoney, ymbill — ЯндексДеньги, для высталения эл.счёта надо указать ymbill и заранее активировать возможность получения счетов от REG.RU; bank — оплата через банк
currency	валюта, обязательное поле, для ЯндексДенег доступно только RUR, для bank и prepay — RUR и USD, для WebMoney так же доступны EUR и UAH
wmid	Номер кошелька WebMoney

Поддержка обработки списка счетов

да

Поля ответа:

Поле	Описание
bills	список счетов
bill_id	номер счёта
currency	валюта (RUR - рубли, USD - доллары США, EUR - евро, UAH - украинские гривны)
payment	сумма счёта без процентов платёжных систем в рублях
total_payment	полная сумма к оплате в указанной Вами валюте, состоит из суммы цен услуг счёта, процентов за перевод денег в указанной системе оплаты, и процентов за конвертацию указанной валюты в рубли, если платёж осуществляется не в рублях
pay_type	способ платежа
pay_status	статус оплаченности счёта: notpayed – счёт не оплачен, payed – оплачено, cancelled – оплата отменена на стороне платёжной системы
wm_invid	номер WebMoney счёта

Пример запроса:

https://api.reg.ru/api/regru2/bill/change_pay_type?username=test&password=test&input_format=json&input_data={"bills":["123456"],"pay_type":"prepay","currency":"RUR"}

Пример ответа:

{
    answer => {
        bills => [
            {
                bill_id       => 123456,
                pay_type      => 'prepay',
                old_pay_type  => 'cash',
                payment       => 100.00,
                total_payment => 100.00,
                currency      => 'RUR',
                pay_status    => 'payed',
                result        => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

6.5. Функция: bill/delete

Назначение:

удаление неоплаченных счетов

Доступность:

клиенты

Поля запроса:

Поле	Описание
bill_id	номер счёта при запросе с одиночным счётом
bills	список номеров счетов

Поддержка обработки списка счетов

да

Поля ответа:

Поле	Описание
bills	список счетов
bill_id	номер счёта
status	статус счёта, выставляется только реальных счетов, deleted для удалённого счёта, active для уже оплаченного счёта не подлежащего удалению
pay_status	статус оплаченности счёта, варианты статусов см. выше

Примеры запросов:

https://api.reg.ru/api/regru2/bill/delete?username=test&password=test&bill_id=12345

https://api.reg.ru/api/regru2/bill/delete?username=test&password=test&input_format=json&input_data={"bills":["12345","12346","12347"]}

https://api.reg.ru/api/regru2/bill/delete?username=test&password=test&input_format=json&input_data={"bills":[{"bill_id":"12345"},{"bill_id":"12346"},{"bill_id":"12347"}]}

Пример ответа:

{
    answer => {
        bills => [
            {
                bill_id    => 12345,
                pay_status => 'notpayed',
                status     => 'deleted',
                result     => 'success'
            },
            {
                bill_id    => '12346',
                pay_status => 'payed',
                status     => 'active',
                error_code => 'BILL_CAN_NOT_REMOVED'
            },
            {
                bill_id    => 12347,
                error_code => 'BILL_ID_NOT_FOUND'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

7. Функции для работы с доменами (категория domain)

7.1. Функция: domain/nop

Назначение:

для тестирования, также позволяет проверить доступность домена и получить его id, если передать username+password+dname

Доступность:

все

Поля запроса:

отсутствуют или стандартные параметры идентификации доменов

Поддержка обработки списка услуг

нет

Поля ответа:

Поле	Описание
service_id	идентификатор домена, присутствует только при передаче имени домена в поле domain_name/dname

Примеры запросов:

проверка доступности API

https://api.reg.ru/api/regru2/domain/nop

проверка существования домена с получением его id

https://api.reg.ru/api/regru2/domain/nop?username=test&password=test&dname=qqq.ru

Пример успешного ответа:

{
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

7.2. Функция: domain/get_prices

Назначение:

Получение цен на регистрацию/продление доменов во всех доступных зонах.

Доступность:

все

Поля запроса:

Поле	Описание
Параметры для аутентификации	используйте аутентификацию для получения партнерских цен.
show_renew_data	флаг возврата цен для продления регистрации (1/0). Необязательное поле.
currency	Идентификатор валюты, в которой будут возвращаться цены (RUR, UAH, USD, EUR). Необязательное поле, по умолчанию цены указываются в рублях.

Поддержка обработки списка услуг

нет

Поля ответа:

Поле	Описание
currency	валюта, в которой возвращены цены
price_group	тарифный план
prices	цены доменнов по зонам Цены указаны за год. Для некоторых зон минимальный срок регистрации больше года. Если для зоны разрешена регистрация русских имен доменов, и она отличается от цены для регистрации доменов с использованием только латинских букв, то для этой зоны возвращается дополнительная запись с префиксом '__idn.'.

Пример запроса:

https://api.reg.ru/api/regru2/domain/get_prices?username=test&password=test

Пример успешного ответа:

{
    'answer' => {
	currency => 'RUR',
	price_group => 'Retail',
	prices => {
	    'ru' => {
		'reg_max_period' => 1,
		'reg_min_period' => 1,
		'reg_price' => '590',
	    },
	    '__idn.com' => {
		'reg_max_period' => 10,
		'reg_min_period' => 1,
		'reg_price' => '960',
	    },
	    'com' => {
		'reg_max_period' => 10,
		'reg_min_period' => 1,
		'reg_price' => '450',
	    },
	    'рф' => {
		'reg_max_period' => 1,
		'reg_min_period' => 1,
		'reg_price' => '1200',
	    },
	},
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

7.3. Функция: domain/get_suggest

Назначение:

подбор имени для домена по ключевым словам, функция работает подобно сервису Reg.Choice

Доступность:

партнёры

Поля запроса:

Поле	Описание
word	Главное ключевое слово, например «дом» или «domain». Обязательное поле.
additional_word	Дополнительное ключевое слово, например «новый» или «cool». Необязательное поле.
category	Категория подбираемых имён. Может принимать значения: 'pattern' — шаблонные («имя + префикс»), 'search_trends' — поисковые тренды, 'all' — все. По умолчанию возвращаются имена из всех категорий.
tlds	Зона, в которой проверяется доступность доменного имени к регистрации. Зоны могут быть такими: 'ru', 'рф', 'su', 'com', 'net', 'org', 'biz', 'info'. Для задания нескольких зон одновременно, необходимо добавить в запрос это поле для каждой зоны: например "...&tlds=ru&tlds=su&tlds=com". Если поле не задано ни разу, то доступность проверяется во всех перечисленных выше зонах.
use_hyphen	Если значение истинно, использовать дефис в для разделения отдельных слов в доменном имени ("cool-domain"). По умолчанию слова склеиваются без разделителя ("cooldomain").
use_plural	Если значение истинно, предлагать варианты во множественном числе. Необязательное поле.

Поддержка обработки списка услуг

нет

Поля ответа:

Поле	Описание
suggestions	Массив хешей с вариантами имён для доменов. Каждый хеш в массиве содержит поле "name" (вариант имени) и массив "avail_in", в котором перечислены зоны, где такое доменное имя доступно к регистрации. Максимальный размер массива — 100.

Пример запроса:

https://api.reg.ru/api/regru2/domain/get_suggest?username=test&password=test&word=дом&additional_word=новый&use_hyphen=1&tlds=ru&tlds=рф

Пример успешного ответа:

{
   "answer" : {
      "suggestions" : [
         {
            "avail_in" : [
               "рф",
               "su"
            ],
            "name" : "дом"
         },
         {
            "avail_in" : [
               "ru",
               "su"
            ],
            "name" : "dom"
         },
         {
            "avail_in" : [
               "рф",
               "su"
            ],
            "name" : "новый"
         },
         {
            "avail_in" : [
               "ru",
               "su",
               "org",
               "biz"
            ],
            "name" : "novii"
         }
      ]
   },
   "result" : "success"
}

Возможные ошибки:

Cм. cтандартные коды ошибок

7.4. Функция: domain/get_premium

Назначение:

возвращает список доступных к регистрации премиум-доменов, функция работает подобно сервису Reg.Premium

Доступность:

партнёры

Поля запроса:

Поле	Описание
tld	Зона премиум доменов. Может быть равно одному из следующих значений: 'ru' – в зоне .RU, 'рф' – в зоне .РФ, 'su' – в зоне .SU (латиница), 'sucyr' – в зоне .SU (кириллица), 'orgcyr' – в зоне .ORG (кириллица). Для задания нескольких зон одновременно, необходимо добавить в запрос это поле для каждой зоны: например "...&tld=ru&tld=рф". По умолчанию берётся зона .RU.
limit	Максимальное количество возвращаемых вариантов. По умолчанию возвращается не более ста вариантов.
max_chars	Максимальное число символов в доменном имени второго уровня. По умолчанию возвращаются домены с любым числом символов.
cat0	Задаёт рубрику возвращаемых премиум-доменов. Должен полностью совпадать с названием одной рубрик сервиса Reg.Premium, например «3-х буквенные». По умолчанию выдаются варианты из рубрики «4-х символьные».
cat1	Задаёт подрубрику рубрики, задаваемой полем cat0, например «Два одинаковых символа». По умолчанию выдаются варианты из всех подрубрик.
cat2	Задаёт подрубрику подрубрики, задаваемой полем cat1, например «XX*». По умолчанию выдаются варианты из всех подрубрик.
random	Если значение равно «1», возвращаются случайные премиум-домены указанной рубрики/подрубрик. По умолчанию возвращаются первые limit доменов в алфавитном порядке.

Поддержка обработки списка услуг

нет

Поля ответа:

Поле	Описание
domains	Массив хешей с премиум-доменами. Каждый хеш в массиве содержит поле "name" (домен) и поле "price" (цена регистрации).

Пример запроса:

https://api.reg.ru/api/regru2/domain/get_premium?username=test&password=test&tld=%D1%80%D1%84&limit=5&cat0=%D0%A6%D0%B8%D1%84%D1%80%D1%8B+%D0%BE%D1%82+00+%D0%B4%D0%BE+9999&cat1=%D0%BE%D1%82+0000+%D0%B4%D0%BE+9999&random=1

Пример успешного ответа:

{
   "answer" : {
      "domains" : [
         {
            "name" : "9466.рф",
            "price" : "1 200"
         },
         {
            "name" : "6956.рф",
            "price" : "1 200"
         },
         {
            "name" : "9392.рф",
            "price" : "1 200"
         },
         {
            "name" : "9482.рф",
            "price" : "1 200"
         },
         {
            "name" : "7950.рф",
            "price" : "1 200"
         }
      ]
   },
   "result" : "success"
}

Возможные ошибки:

Cм. cтандартные коды ошибок

7.5. Функция: domain/check

Назначение:

проверка доступности регистрации домена

Доступность:

партнёры

Поля запроса:

Поле	Описание
domain_name	Имя домена, поле не совместимо со спиcком domains.
domains	Массив со списком вариантов имён доменов, каждый элемент массива является хешем с ключём dname или domain_name. Используется только в случае запроса в форматах JSON, XML.
is_transfer	При значении 1 делается проверка на возможность переноса домена в REG.RU, при нулевом значении — обычная проверка на возможность регистрации, по умолчанию — 0
subtype	Тип регистрации. Опциональное поле. Возможное значение (кроме пустого значения по умолчанию): «preorder» — предзаказ доменов .РФ.

Поддержка обработки списка услуг

да

Поля ответа:

Поле	Описание
domains	Массив со списком хешей, содержащий имена доменов dname и их доступность. При положильном ответе поле result будет иметь значение Available.

Пример запроса:

https://api.reg.ru/api/regru2/domain/check?username=test&password=test&input_format=json&input_data={"domains":[{"dname":"ya.ru"},{"dname":"yayayayayaya.ru"},{"dname":"xn--000.com"},{"dname":"china.cn"},{"dname":"ййй.me"},{"dname":"wwww.ww"},{"dname":"a.ru"},{"dname":"qqйй.com"}]}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'ya.ru',
                result     => 'Domain already exists, use whois service',
                error_code => 'DOMAIN_ALREADY_EXISTS'
            },
            {
                dname      => 'yayayayayaya.ru',
                result     => 'Available'
            },
            {
                dname      => 'xn--000.com',
                result     => 'Invalid punycode value for domain_name',
                error_code => 'INVALID_DOMAIN_NAME_PUNYCODE'
            },
            {
                dname      => 'china.cn',
                result     => 'Registration in .cn TLD is not available',
                error_code => 'TLD_DISABLED'
            },
            {
                dname      => 'ййй.me',
                result     => 'Invalid domain name: ййй.me',
                error_code => 'DOMAIN_BAD_NAME'
            },
            {
                dname      => 'wwww.ww',
                result     => 'domain_name is invalid or unsupported zone',
                error_code => 'INVALID_DOMAIN_NAME_FORMAT'
            },
            {
                dname      => 'a.ru',
                result     => 'Invalid domain name length, You have entered too short or too long name',
                error_code => 'DOMAIN_INVALID_LENGTH'
            },
            {
                dname      => 'qqйй.com',
                result     => 'You can not mix latin and cyrillic letters in domain names',
                error_code => 'HAVE_MIXED_CODETABLES'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

7.6. Функция: domain/create

Назначение:

подать заявку на регистрацию домена.

Доступность:

клиенты

Поля запроса:

Поле	Мин. длина	Макс. длина	Описание
domain_name	зависят от зоны		Имя регистрируемого домена. Допустимые символы (есть или нет IDN) и длина поля зависят от доменной зоны. Обязательное поле. P.S. Возможность оптовой регистрации (большое количество доменов одной зоны) одним запросом для VIP-клиентов.
period	1	2	Период, на который производится регистрация домена, допустимые значения зависят от доменной зоны, например, для .ru и .su только 1. Обязательное поле.
enduser_ip	11	15	IP-адрес конечного пользователя (пользователя, который сделал заказ). Обязательное поле для партнёра, у обычного клиента по умолчанию подставляется IP-адрес с которого делается запрос.
contacts	—		Группирующий хеш полей контактных данных. Список полей зависит от регистрируемой зоны и/или является ли будущий владелец домена физ. или юридическим лицом. Применим только при передаче данных в JSON или XML форматах.
profile_type	—		Тип профиля контактных данных пользователя. Параметр не совместим с явным указанием контактных данных (имеет больший приоритет — перезаписывает их) и требует указания имени профиля profile_name. На данный момент допустимы такие варианты: GTLD, EU, RU.PP, RU.ORG. В дальнейшем их количество будет увеличено.
profile_name	—		Имя профиля контактных данных пользователя. Параметр не совместим с явным указанием контактных данных (имеет больший приоритет — перезаписывает их) и требует указания имени профиля profile_type. Для разных типов профилей имена могут повторяться. На данные момент создаются профили только через web-интерфейс.
nss	—		Группирующий хеш полей имён и IP-адресов NS-серверов. Применим только при передаче данных в JSON или XML форматах.
not_delegated	1		При выставлении этого флага для .ru, .su и .рф доменов игнорируются значения полей NS-серверов, хеша NSS и домен регистрируется неделегированным. Для остальных зон не применим. Допустимые значения 0 и 1.
user_servid	32	32	ID домена, задаваемый пользователем. Допустимые символы: цифры 0..9 и латинские буквы a..f. Автоматически идентификатор не создаётся, т.е. если он не был задан при создании услуги, то поле остаётся пустым. Необязательное поле.
comment	0	255	Комментарий. Необязательное поле.
point_of_sale pay_type ok_if_no_money	—		См. Общие параметры оплаты.
subtype	0	15	Тип регистрации. Опциональное поле. Возможное значение (кроме пустого значения по умолчанию): «preorder» — предзаказ доменов .РФ.

Описание полей для работы с папками

Поля этой категории являются необязательными.

Поле	Описание
folder_name	Папка, в которую будет добавлен домен. Если указано имя несуществующей папки и не установлен флаг no_new_folder - папка будет создана.
folder_id	Числовой идентификатор папки, в которую будет добавлен домен.
no_new_folder	Не создавать папку если она не существует.

Описание полей контактных данных

Контактные данные для .RU/.SU/.РФ доменов

Обратите внимание, что в этой операции допустимо использовать один из двух взаимоисключающих наборов полей — данные организации (если домен регистрируется на организацию), либо данные частного лица (если домен регистрируется на частное лицо).
Также некоторые поля могут быть многострочными.

Поле	Мин. длина	Макс. длина	Описание
Общие поля для .RU/.SU/.РФ
total_pp_flag	1	1	Активация услуги полного скрытия персональных данных
sms_security_number	8	25	Номер для отправки SMS-сообщений администратору домена. Используется для уведомлений и подтверждений операций с доменом с целью обеспечения дополнительной безопасности и выполнения условий п. 5.2. правил регистрации доменных имён в доменах .ru .рф. Запись не является обязательной. Пример: +7 927 1234567
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
Данные организации (только при регистрации домена на организацию!)
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
Данные частного лица (только при регистрации домена на частное лицо!)
person	8	64	Имя, первая буква отчества (без точки) и фамилия администратора домена, записанные латинскими буквами. Предназначено для использования услугой 'whois'. Для иностранцев поле содержит имя в оригинальном написании (или в английской транслитерации). Пример: Vassily N Pupkin
person_r	9	64	Фамилия, имя и отчество администратора домена на русском языке в соответствии с паспортными данными. Для иностранцев поле содержит имя в оригинальном написании (при невозможности в английской транслитерации). Пример1: Пупкин Василий Николаевич Пример2: John Smith
private_person_flag	1	1	Активация услуги частичного скрытия персональных данных
passport	20	255 много- строчное	Серия и номер паспорта, а также наименование органа, выдавшего паспорт, и дата выдачи (в указанной последовательности, с разделением пробелами). В написании римских цифр допустимо использование только латинских букв. Дата записывается в формате ДД.ММ.ГГГГ. Знак номера перед номером паспорта не ставится. Паспорта СССР (паспорта старого образца) не принимаются. В случае использования документа, отличного от паспорта (допустимо ТОЛЬКО для нерезидентов России), в начале строки указывается наименование вида документа. Запись может быть многострочной. Пример: 34 02 651241 выдан 48 о/м г.Москвы 26.12.1990
birth_date	10	10	Дата рождения администратора домена в формате ДД.ММ.ГГГГ. Пример: 07.11.1917
country	2	2	Двухбуквенный ISO-код страны, гражданином которой является частное лицо. Пример: RU
code	12	12	Идентификационный номер налогоплательщика (ИНН), присвоенный администратору домена. Параметр указывается только в том случае, если администратор выступает как индивидуальный предприниматель. Пример: 789012345678

Контактные данные для доменной зоны .tj

На данный момент все контактные данные должны заполняться латиницей.

Поле	Мин. длина	Макс. длина	Описание
Данные владельца домена
o_type	1	1	Тип контакта. "1" для регистрации домена на физическиое лицо, "2" - для регистрации домена на юридическое лицо.
o_whois	2	64	Описание домена. Отображается в whois-запросе.
o_full_name	2	64	Владелец домена: полное название организации или ФИО владельца.
o_email	6	90	Адрес электронной почты владельца домена в формате RFC-822.
o_phone	10	16	Телефон владельца домена, указывается в международном формате с пробелами между кодом страны, кодом города и внутренним номером. (Пример: +7 495 1234567 или +662 22 1234567)
o_fax	10	16	Факс владельца домена, указывается в международном формате с пробелами между кодом страны, кодом города и внутренним номером. (Пример: +7 495 1234567 или +662 22 1234567)
o_addr	2	128	Адрес владельца домена: юридический адрес организации в соответствии с учредительными документами или адрес проживания владельца домена.
o_city	2	64	Адрес владельца домена: город.
o_country_code	2	2	Двухбуквенный ISO-код страны владельца домена. Список кодов всех стран можно найти здесь
Данные администратора домена
a_full_name	2	64	ФИО администратора домена.
a_nic_name	2	32	Краткое имя администратора или его nickname, одно слово.
a_email	6	90	Адрес электронной почты администратора домена в формате RFC-822.
a_fax	10	16	Телефон(!) администратора домена, указывается в международном формате с пробелами между кодом страны, кодом города и внутренним номером. (Пример: +7 495 1234567 или +662 22 1234567)
a_addr	2	128	Адрес администратора домена.
a_city			Адрес администратора домена: город.
a_postcode	3	10	Адрес администратора домена: почтовый индекс.
a_country_code	2	2	Двухбуквенный ISO-код страны администратора домена. Список кодов всех стран можно найти здесь
Данные технического администратора домена
t_full_name	2	64	ФИО технического администратора домена.
t_nic_name	2	32	Краткое имя технического администратора или его nickname, одно слово.
t_email	6	90	Адрес электронной почты технического администратора домена в формате RFC-822.
t_fax	10	16	Телефон(!) технического администратора домена, указывается в международном формате с пробелами между кодом страны, кодом города и внутренним номером. (Пример: +7 495 1234567 или +662 22 1234567)
t_addr	2	128	Адрес технического администратора домена.
t_city	2	64	Адрес технического администратора домена: город.
t_postcode	3	10	Адрес технического администратора домена: почтовый индекс.
t_country_code	2	2	Двухбуквенный ISO-код страны технического администратора домена. Список кодов всех стран можно найти здесь

Регистрация доменов в зонах com.ua, kiev.ua

На данный момент все контактные данные должны заполняться латинскими буквами.
Для доменных зон com.ua, kiev.ua используется только два вида контактов: контакты владельца (администратора) домена и технические контакты.
Изменение контактных данных владельца домена после регистрации в автоматическом режиме невозможно.

Поле	Мин. длина	Макс. длина	Описание
Данные владельца домена
o_company	5	80	Название организации - владельца домена.
o_first_name	2	40	Имя контактного лица
o_last_name	2	40	Фамилия контактного лица
o_email	6	80	Контактный 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-код страны контактного лица. Список всех кодов стран можно найти тут
Данные техподдержки домена
t_company	5	80	Организация, осуществляющая техподдержку домена.
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-код страны контактного лица. Список всех кодов стран можно найти тут

Регистрация доменов в зоне pp.ua

На данный момент все контактные данные должны заполняться латинскими буквами.
При регистрации домена в зоне pp.ua в контактных данных владельца домена необходимо указывать номер мобильного телефона. После регистрации домена на этот номер будет отправлено SMS с кодом активации домена, который вместе с именем домена нужно ввести здесь: http://www.pp.ua/rus/confirm.html.
Допускается регистрировать не более трёх доменов в месяц на один мобильный телефон.
Подробнее с правилами домена pp.ua можно ознакомиться здесь.
Остальные правила регистрации доменов в зоне pp.ua соответствуют правилам регистрации доменов в других зонах.

Регистрация доменов в зонах *.kz (все домены Казахстана)

С 7 сентября 2010 г. в соответствии с Правилами KazNIC в контактных данных домена необходимо указывать адрес серверного оборудования, на котором располагается домен. Домены, зарегистрированные после указанной даты, обязаны располагаться на серверах Казахстана.

Для указания адреса серверного оборудования при регистрации домена или изменении контактов необходимо добавить следующие поля в хеш contacts.

Поле	Мин. длина	Макс. длина	Описание
Адрес серверного оборудования
srvloc_state	2	40	Область / Штат
srvloc_city	2	40	Город
srvloc_street	2	255	Адрес (улица, дом)

Если не планируется сразу привязывать домен к хостингу или парковке, можно использовать следующие значения для полей адреса серверного оборудования:

srvloc_state:	KAR
srvloc_city:	Karaganda
srvloc_street:	Chizhevskogo, 17

Регистрация доменов в других зонах

Поле	Мин. длина	Макс. длина	Описание
Данные владельца домена
o_company	5	80	Название организации - владельца домена.
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-код страны владельца домена. Некоторые доменные зоны допускают указание только стран официально подпадающих под эту зону. Например, для .eu допустимо указывать только страны входящие в EC. Список кодов всех стран можно найти здесь
Данные администратора домена
a_company	5	80	Название организации - владельца домена.
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	Организация, осуществляющая техподдержку домена.
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-код страны контактного лица. Список всех кодов стран можно найти тут
Биллинговые контакты домена
b_company	5	80	Организация.
b_first_name	2	40	Имя контактного лица
b_last_name	2	40	Фамилия контактного лица
b_email	6	80	Контактный email-адрес контактного лица.
b_phone	8	20	Номер телефона контактного лица. Телефон указывается с международном формате. (Пример: +7.4952171179).
b_fax	8	20	Номер телефакса контактного лица. Телефон указывается с международном формате. (Пример: +7.4952171179).
b_addr	8	80	Адрес контактного лица: улица, дом, офис (квартира)
b_city	2	80	Адрес контактного лица: город
b_state	2	40	Адрес контактного лица: область/край/штат
b_postcode	3	10	Почтовый индекс контактного лица
b_country_code	2	2	Двухбуквенный ISO-код страны контактного лица. Список всех кодов стран можно найти тут
Дополнительные данные для доменов в зонах .COM, .NET, .ORG, .BIZ, .NAME, .INFO, .MOBI, .UK, .CC, .TV, .WS, .BZ, .ME
private_person_flag	1	1	Активация услуги Privacy Protection
Дополнительные данные для доменов в зоне .US
RselnexusAppPurpose	2	2	Сфера использования домена Возможные значения: P1 - Бизнес, для получения прибыли P2 - Бизнес, не для получением прибыли P3 - Для персонального использования P4 - Для образовательных целей P5 - Для государственных целей
RselnexusCategory	3	3	Владелец домена: Возможные значения: C11 - Физическое лицо - Гражданин США C12 - Физическое лицо - постоянный резидент США или любой из его территорий C21 - Юридическое лицо или организация, инкорпорированная в одном из 50-ти штатов США C31 - Юридическое лицо или организация, которую регулярно ведет законную деятельность в США C32 - Юридическое лицо или организация, которая имеет офис или другое имущество в США

DNS-серверы домена

Для регистрации домена должно быть указано не менее двух серверов. В случае указания NS-серверов на базе одного из заказываемых доменов, обязателельно должны быть указаны IP-адреса этих NS-серверов.

Имя поля	Мин. длина	Макс. длина	Описание поля
ns0	6	80	Имя хоста первого DNS-сервера.
ns1	6	80	Имя хоста второго DNS-сервера.
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.reg.ru и ns2.reg.ru. При этом на данных серверах будет прописана зона для Вашего домена. Управлять зоной впоследствии можно будет через web-интерфейс сайта reg.ru.

Поддержка обработки списка услуг

Только для VIP клиентов.

Поля ответа:

Поле	Описание
bill_id	Номер счёта, созданного по запросу.
payment	Сумма заказа в рублях.
pay_type	Способ оплаты. На данный момент возможна только предоплата, prepay.
pay_notes	Комментарий, относящийся к используемому способу оплаты.
domains	Список доменов с результатом, содержит поля: dname — имя домена, result — поле результатов, service_id — внутреннний id домена в случае успешного принятия заявки. Поле result может иметь следующие значения: success — заказ на регистрацию принят, Invalid TLD — ошибка в имени доменной зоны, Registraion in this TLD unavailable — регистрация доменов этой зоны ещё недоступна, Invalid punycode input — ошибка в punycode имени домена, Domain_name is invalid or unsupported zone — ошибка в доменном имени или неподдерживаемая зона, Unavailable domain name — такое доменное имя не доступно для регистрации.

Примеры запросов:

пример заказа одного .ru домена, используя запрос в «PLAIN» формате:

https://api.reg.ru/api/regru2/domain/create?username=test&password=test&country=RU&e_mail=test@test.ru&person_r=Рюрик Святослав Владимирович&phone=%2B7 495 1234567&birth_date=01.01.1101&descr=Vschizh site&person=Svyatoslav V Ryurik&p_addr=12345, г. Вщиж, ул. Княжеска, д.1, Рюрику Святославу Владимировичу&passport=22 44 668800, выдан по месту правления 01.01.1164&domain_name=vschizh.ru&ns0=ns1.reg.ru&ns1=ns2.reg.ru

Обратите внимание, что если Ваша библиотека/программа не делает полного автоматического преобразования данных, то «+» надо передавать как «%2B».

пример подобного запроса в JSON-формате, для наглядности отправляемые данные сначала представлены ввиде структуры на Perl-e с преобразованием её в JSON-формат:

$jsondata = {
    contacts => {
        descr => 'Vschizh site',
        person => 'Svyatoslav V Ryurik',
        person_r => 'Рюрик Святослав Владимирович',
        passport => '22 44 668800, выдан по месту правления 01.09.1164',
        birth_date => '01.01.1101',
        p_addr => '12345, г. Вщиж, ул. Княжеска, д.1, Рюрику Святославу Владимировичу, князю Вщижскому',
        phone => '+7 495 1234567',
        e_mail => 'test@test.ru',
        country => 'RU',
    },
    nss => {
        ns0 => 'ns1.reg.ru',
        ns1 => 'ns2.reg.ru',
    },
    domain_name => 'vschizh.su',
};

$jsondata = JSON::XS->new->utf8->encode( $jsondata );

и сам запрос:

https://api.reg.ru/api/regru2/domain/create?username=test&password=test&input_format=json&input_data={"contacts":{"country":"RU","e_mail":"test@test.ru","person_r":"Рюрик Святослав Владимирович","phone":"%2B7 495 1234567","birth_date":"01.01.1101","descr":"Vschizh site","person":"Svyatoslav V Ryurik","p_addr":"12345, г. Вщиж, ул. Княжеска, д.1, Рюрику Святославу Владимировичу, князю Вщижскому","passport":"22 44 668800, выдан по месту правления 01.09.1164"},"domain_name":"vschizh.su","nss":{"ns0":"ns1.reg.ru","ns1":"ns2.reg.ru"}}

тоже самое, но предполагается что контактные данные храняться в профиле my_like_ru_profile:

$jsondata = {
    profile_type => 'RU.PP',
    profile_name => 'my_like_ru_profile',
    nss => {
        ns0 => 'ns1.reg.ru',
        ns1 => 'ns2.reg.ru',
    },
    domain_name => 'vschizh.su',
};

$jsondata = JSON::XS->new->utf8->encode( $jsondata );

и сам запрос:

https://api.reg.ru/api/regru2/domain/create?username=test&password=test&input_format=json&input_data={"profile_type":"RU.PP","profile_name":"my_like_ru_profile","domain_name":"vschizh.su","nss":{"ns0":"ns1.reg.ru","ns1":"ns2.reg.ru"}}

Примеры успешных ответов:

пример ответа на первый запрос (запрос в «PLAIN» формате):

{
    answer => {
	domains   => [
	    {
		dname      => 'vschizh.ru',
		result     => 'success',
		service_id => 12345
	    }
	],
	payment   => '600',
	pay_notes => 'Amount successfully charged',
	pay_type  => 'prepay',
	bill_id   => '1234'
    },
    result => 'success'
}

пример ответа на второй запрос (запрос в JSON формате):

{
    answer => {
	domains   => [
	    {
		dname      => 'vschizh.su',
		result     => 'success',
		service_id => 12345
	    }
	],
	payment   => '600',
	pay_notes => 'Amount successfully charged',
	pay_type  => 'prepay',
	bill_id   => '1234'
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

7.7. Функция: domain/transfer

Назначение:

подать заявку на перенос домена от другого регистратора

Доступность:

клиенты

Поля запроса:

Совпадают с полями для функции domain/create. Помимо этого для доменов .RU / .SU / .РФ зон данные владельца домена и DNS-сервера можно не указывать, т.е. оставлять хеши contacts и nss пустыми. Эти данные будут автоматически получены из реестра в момент принятия домена. Также для доменов .RU / .SU / .РФ поле period может принимать значение "0" (перенос доменов без продления). Для большинства международных доменов (com net org info biz mobi name asia tel in mn bz cc tv us me cn nz co ca и др.) дополнительно надо указать authinfo

Поле	Мин. длина	Макс. длина	Описание
authinfo	6	32	Ключ аутентификации для переноса домена (для международных доменов). Уточняется у предыдущего регистратора домена.

Поддержка обработки списка услуг

Только для VIP клиентов

Поля ответа:

Совпадают с полями для функции domain/create

Возможные ошибки:

Error_code	Error_text	Описание
AUTHINFO_NOT_FOUND	Transfer secretkey not found	Секретный ключ для переноса не найден
INVALID_AUTHINFO	Inadmissible chars in authinfo	Недопустимые символы в поле authinfo

Так же см. Стандартные коды ошибок

7.8. Функция: domain/get_rereg_data

Назначение:

получить список освобождающихся доменов с характеристиками, данные обновляются 1 раз в 30 минут

Доступность:

клиенты

Поля запроса:

Поле	Описание
limit	Сколько отдавать записей за 1 запрос, значение по умолчанию — 1000, максимальное значение — 1000
limit_from	С какой позиции (записи) отдавать данные, значение по умолчанию — 0

Полный список всех освобождающихся доменов одним файлом в CSV формате можно скачать тут

Поддержка обработки списка услуг

нет

Поля ответа:

Поле	Описание
lot_type	Тип ставки
dname	Имя домена
lot_date	Дата создания лота
ripn_delete_date	Дата удаления из реестра
price0	Минимальная ставка
price	Максимальная ставка
uni_avg_attendance	Среднее кол-во посетителей за день
avg_viewings	Среднее кол-во просмотров за день
all_avg_traffic	Средний трафик за день
search_query_list	Список поисковых запросов
yandex_tic	Яндекс тИЦ
google_pr	Google Page Rank
is_recommended	Премиум домен

Пример запроса:

https://api.reg.ru/api/regru2/domain/get_rereg_data?username=test&password=test&output_format=json

Пример успешного ответа:

{
    answer => [
        {
            uni_avg_attendance => 100,
            price0             => '2500.00',
            ripn_delete_date   => '2010-12-31',
            avg_viewings       => 2,
            all_avg_traffic    => 3,
            yandex_tic         => 1000,
            search_query_list  => 'слово дело',
            dname              => 'test.ru',
            google_pr          => 9,
            price              => '2500.00',
            is_recommended     => 1
        },
        {
            uni_avg_attendance => 0,
            price0             => '600.00',
            ripn_delete_date   => '2020-12-31',
            avg_viewings       => 0,
            all_avg_traffic    => 0,
            yandex_tic         => 0,
            search_query_list  => undef,
            dname              => 'test.su',
            google_pr          => 0,
            price              => '600.00',
            is_recommended     => 0
        },
    ],
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

7.9. Функция: domain/set_rereg_bids

Назначение:

сделать ставки на освобождающиеся домены, подробнее смотрите здесь

Доступность:

клиенты
Так же партнёры компании REG.RU может внести предварительную оплату в размере 225 руб., а остаток суммы оплатить в случае успешного выполнения заявки на регистрацию в течении 10 дней после её исполнения (см. ниже параметр instalment). При выборе данного порядка оплаты домен будет зарегистрирован на REG.RU, а после оплаты полной стоимости автоматически перерегистрирован на указанные Вами данные. В случае невыполнения обязательств по оплате полной стоимости в установленный срок предварительная оплата будет считаться неустойкой и не подлежит возмещению.
Подробнее см. Договор пп. 2.16, 2.17, 3.2.9, 6.11.

Поддержка обработки списка услуг

да

Поля запроса:

Поле	Описание
contacts	Хеш контактных данных; описание контактных данных, являющихся ключами хеша, см. в функции domain/create.
nss	Хеш NS-серверов; описание формата NS-серверов, являющихся ключами хеша, см. в функции domain/create.
domains	Массив со списком доменов, каждый элемент массива является хешем с ключами dname — имя домена и price — ценой/ставкой на этот домен. Для партнёров доступен заказ по частичной оплате, ключ instalment, допустимые значения 0 и 1, в этом случае можно установить автоматическую оплату после активации домена при наличии денег на счету, ключ autopay, допустимые значения 0 и 1.

Поля ответа:

Поле	Описание
bill_id	Номер счёта, созданного по запросу.
payment	Сумма заказа в рублях.
pay_type	Способ оплаты. На данный момент возможна только предоплата, prepay.
pay_notes	Комментарий, относящийся к используемому способу оплаты.
domains	Список доменов с результатом по каждому, поле результатов может иметь такие значения: success — ставка сделана, Invalid domain zone — для этой зоны нет возможности заказа освобождающихся доменов, Domain not found — домен не обслуживается REG.RU, Rereg not found — домен не найден в списке доступных освобождающихся доменов (например, он уже имеет предельную ставку), Invalid bid — недопустимая ставка, More bid found — найдена такая же или большая ставка.

Пример запроса:

пример отправляемых данных (структура на Perl-e) с преобразованием её в JSON-формат:

$jsondata = {
    contacts => {
        descr      => 'Vschizh site',
        person     => 'Svyatoslav V Ryurik',
        person_r   => 'Рюрик Святослав Владимирович',
        passport   => '22 44 668800, выдан по месту правления 01.09.1164',
        birth_date => '01.01.1101',
        p_addr     => '12345, г. Вщиж, ул. Княжеска, д.1, Рюрику Святославу Владимировичу, князю Вщижскому',
        phone      => '+7 495 1234567',
        e_mail     => 'test@test.ru',
        country    => 'RU',
    },
    nss => {
        ns0 => 'ns1.reg.ru',
        ns1 => 'ns2.reg.ru',
    },
    domains => [
        { dname => 'vschizh.ru', price => 225 },
        # или заказ в рассрочку: { dname => 'vschizh.ru', price => 2500, instalment => 1 },
        { dname => 'vschizh.su', price => 400 },
    ],
};

$jsondata = JSON::XS->new->utf8->encode( $jsondata );

Сам запрос:

https://api.reg.ru/api/regru2/domain/set_rereg_bids?username=test&password=test&input_format=json&input_data={"contacts":{"country":"RU","e_mail":"test@test.ru","person_r":"Рюрик Святослав Владимирович","phone":"%2B7 495 1234567","birth_date":"01.01.1101","descr":"Vschizh site","person":"Svyatoslav V Ryurik","p_addr":"12345, г. Вщиж, ул. Княжеска, д.1, Рюрику Святославу Владимировичу, князю Вщижскому","passport":"22 44 668800, выдан по месту правления 01.01.1164"},"domains":[{"dname":"vschizh.ru","price":225},{"dname":"vschizh.su","price":400}],"nss":{"ns0":"ns1.reg.ru","ns1":"ns2.reg.ru"}}

Тоже самое, но с использованием wget для post-запроса (параметр --post-data) и выводом ответа в консоль:

wget -O - https://api.reg.ru/api/regru2/domain/set_rereg_bids --post-data='username=test&password=test&input_format=json&input_data={"contacts":{"country":"RU","e_mail":"test@test.ru","person_r":"Рюрик Святослав Владимирович","phone":"%2B7 495 1234567","birth_date":"01.01.1101","descr":"Vschizh site","person":"Svyatoslav V Ryurik","p_addr":"12345, г. Вщиж, ул. Княжеска, д.1, Рюрику Святославу Владимировичу, князю Вщижскому","passport":"22 44 668800, выдан по месту правления 01.01.1164"},"domains":[{"dname":"vschizh.ru","price":225},{"dname":"vschizh.su","price":400}],"nss":{"ns0":"ns1.reg.ru","ns1":"ns2.reg.ru"}}'

Обратите внимание, что если Ваша библиотека/программа не делает полного автоматического преобразования данных, то «+» надо передавать как «%2B».

Пример успешного ответа:

результат для приведенного выше запроса wget:

{
   "answer" : {
      "domains" : [
         {
            "dname" : "vschizh.ru",
            "result" : "success",
            "service_id" : 12345
         },
         {
            "dname" : "vschizh.su",
            "result" : "success",
            "service_id" : 12346
         }
      ],
      "bill_id" : "1234",
      "pay_type" : "prepay",
      "pay_notes" : "Amount successfully charged",
      "payment" : "625",
   },
   "result" : "success"
}

Возможные ошибки:

Error_code	Error_text	Описание
CONTACTS_NOT_FOUND	Contacts list not found.	Контактная информация не найдена.
INVALID_CONTACTS	Contacts user data is invalid: $error_detail.	Ошибка в контактных данных пользователя: <уточнение>.
NSS_NOT_FOUND	Name servers list not found.	Список NS-серверов не найден.
DOMAINS_NOT_FOUND	Domains list not found.	Список доменов не найден.
UNKNOWN_CONTYPE	Can't guess registrant type (person or organization).	Не определён тип контакта (физ.лицо или организация).

А также Стандартные коды ошибок

7.10. Функция: domain/get_user_rereg_bids

Назначение:

получить список освобождающихся доменов со своими ставками, в списке так же присутсвуют домены по которым ставка перебита

Доступность:

клиенты

Поля запроса:

нет

Поддержка обработки списка услуг

нет

Поля ответа:

Поле	Описание
dname	Имя домена
tld	Доменная зона
is_active	Возможны ли торги по данному лоту
is_recommended	Премиум домен
uni_avg_attendance	Среднее кол-во посетителей за день
avg_viewings	Среднее кол-во просмотров за день
all_avg_traffic	Средний трафик за день
search_query_list	Список поисковых запросов
first_creation_date	дата самой первой регистрации домена по данным stat.reg.ru
delete_date	Дата удаления из реестра
yandex_tic	Яндекс тИЦ
google_pr	Google Page Rank
registrar	Регистратор, у которого домен находится сейчас на обслуживании
user_bid	Ваша последняя ставка
max_bid	Максимальная ставка на этот домен, если лот ещё активен, то вы можете её перебить независимо от того кто её сделал
next_price	Следующая минимальная ставка, имеет значение NULL для неактивных лотов
blitz_price	Максимальная ставка, при её достижении домен снимается с торгов (is_active = 0), но будет присутствовать в этом списке до момента освобождения домена реестром
rereg_bids	список всех возможных ставок отдельно по каждой доменной зоне (для справки)

Пример запроса:

https://api.reg.ru/api/regru2/domain/get_user_rereg_data?username=test&password=test

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                delete_date        => '2099-12-31',
                yandex_tic         => null,
                max_bid            => 225.00,
                next_price         => 590.00,
                uni_avg_attendance => null,
                blitz_price        => 8000.00,
                user_bid           => 225.00,
                search_query_list  => null,
                tld                => 'ru',
                dname              => 'test.ru',
                registrar          => 'REGRU',
                is_active          => 1,
                avg_viewings       => null,
                first_create_date  => '2000-01-01',
                google_pr          => null,
                is_recommended     => 1,
                all_avg_traffic    => null
            },
            {
                delete_date        => '2099-01-01',
                yandex_tic         => 2000,
                max_bid            => 5000.00,
                next_price         => null,
                uni_avg_attendance => null,
                blitz_price        => 5000.00,
                user_bid           => 5000.00,
                search_query_list  => null,
                tld                => 'su',
                dname              => 'test.su',
                registrar          => 'REGRU',
                is_active          => 0,
                avg_viewings       => null,
                first_create_date  => '2001-01-01',
                google_pr          => 9,
                is_recommended     => 1,
                all_avg_traffic    => null
            }
        ],
        rereg_bids => {
            рф => [ 0, 225, 590, 750, 2500, 5000, 8000 ],
            su => [ 0, 400, 590, 750, 2500, 5000, 8000 ],
            ru => [ 0, 225, 590, 750, 2500, 5000, 8000 ]
        }
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

7.11. Функция: domain/get_docs_upload_uri

Назначение:

получение ссылки на закачивание документов из интернета для .RU/.SU/.РФ доменов

Доступность:

клиенты

Поля запроса:

стандартные поля для идентификации домена

Поддержка обработки списка услуг:

нет

Поля ответа:

Поле	Описание
docs_upload_sid	идентификатор закачиваемого документа
url	ссылка для закачивания документа, включает в себя идентификатор docs_upload_sid

Пример запроса:

https://api.reg.ru/api/regru2/domain/get_docs_upload_uri?username=test&password=test&dname=test.ru

Пример успешного ответа:

{
    answer => {
        url => 'http://www.reg.ru/user/docs/add?userdoc_secretkey=123456',
        docs_upload_sid => '123456',
    },
    result => 'success'
}

Возможные ошибки:

Error_code	Error_text	Описание
CANT_GET_DOCS_UPLOAD_SID	Can't get documents upload sid.	Не удалось получить sid загрузки документов.

А также Стандартные коды ошибок

7.12. Функция: domain/update_contacts

Назначение:

Изменение контактных данных домена

Доступность:

клиенты

Поля запроса:

Поле	Описание
contacts	Хеш контактных данных; описание контактных данных, являющихся ключами хеша, см. в функции domain/create. Нужно только в случае запроса в форматах JSON, XML
domains	Массив со списком доменов, каждый элемент массива является хешем с ключём dname, имя домена, или service_id. Домены в списке должны быть однотипные, т.е. все относится к одной доменной зоне или принадлежать к одной из групп: – .ru, .su и тип контактных данных person; – .ru, .su и тип контактных данных org; – .com.ua, .kiev.ua; – .com, .net, .org, .biz, .info, .name, .mobi. Нужно только в случае запроса в форматах JSON, XML

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов с параметрами dname, service_id и/или error_code c кодом ошибки

Примеры запросов:

Запрос с одним доменом

https://api.reg.ru/api/regru2/domain/update_contacts?username=test&password=test&country=RU&e_mail=test@test.ru&person_r=Рюрик Святослав Владимирович&phone=%2B7 495 1234567&birth_date=01.01.1101&descr=Vschizh site&person=Svyatoslav V Ryurik&p_addr=12345, г. Вщиж, ул. Княжеска, д.1, Рюрику Святославу Владимировичу&passport=22 44 668800, выдан по месту правления 01.01.1164&domain_name=vschizh.ru

Запрос со списком доменов

https://api.reg.ru/api/regru2/domain/update_contacts?input_format=json&input_data={"username":"test","password":"test","contacts":{"country":"RU","e_mail":"test@test.ru","person_r":"Рюрик Святослав Владимирович","phone":"%2B7 495 1234567","birth_date":"01.01.1101","descr":"Vschizh site","person":"Svyatoslav V Ryurik","p_addr":"12345, г. Вщиж, ул. Княжеска, д.1, Рюрику Святославу Владимировичу, князю Вщижскому","passport":"22 44 668800, выдан по месту правления 01.01.1164"},"domains":[{"dname":"vschizh.ru"},{"dname":"vschizh.su"}]}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'vschizh.ru',
                service_id => '12345',
                result     => 'success'
            },
            {
                dname      => 'vschizh.su',
                service_id => '12346',
                result     => 'success'
            }
        ],
    }
    result => 'success'
}

Возможные ошибки:

Error_code	Error_text	Описание
INCOMPATIBLE_CONTYPES	Incompatible .ru/.su/.рф domain contypes	Несовместимые типы контактов для .ru/.su/.рф доменов
INCOMPATIBLE_ZONES	Incompatible domain zones	Несовместимые доменные зоны
PP_UPDATE_FAIL	Part success: update contacts is OK, update Private Person is fail	Частичное выполнение: контатные данные обновлены успешно, изменение Private Person или Total Private Person завершилось с ошибкой

А также Стандартные коды ошибок

7.13. Функция: domain/update_private_person_flag

Назначение:

Изменение флага Private Person и Total Private Person скрытия/отображения контактных данных в whois

Доступность:

клиенты

Поля запроса:

Поле	Допустимые значения	Описание
private_person_flag	0 и 1	Установка/снятие флага частичного скрытия персональных данных
total_pp_flag	0 и 1	Установка/снятие флага полного скрытия персональных данных

А также стандартные поля для идентификации списка домена

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов с параметрами dname, service_id и/или error_code c кодом ошибки
pp_flag	соответствует переданному значению входного параметра private_person_flag, возможные ответы: 'is set' и 'is cleared'

Пример запроса:

https://api.reg.ru/api/regru2/domain/update_private_person_flag?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"vschizh.ru"},{"dname":"vschizh.su"}],"private_person_flag":"1"}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'vschizh.ru',
                service_id => '12345',
                result     => 'success'
            },
            {
                dname      => 'vschizh.su',
                service_id => '12346',
                result     => 'success'
            }
        ],
        pp_flag => 'is set'
    }
    result => 'success'
}

Возможные ошибки:

А также Стандартные коды ошибок

7.14. Функция: domain/register_ns

Назначение:

внесение домена в NSI-registry, работает только для международных доменов

Доступность:

все

Поля запроса:

Поле	Описание
domain_name	домен, nameserver которого будет добавляться
ns0	nameserver
ns0ip	IP адрес добавляемого nameserver-а

Поддержка обработки списка услуг:

нет

Поля ответа:

Поле	Описание
resp	детализированный ответ регистратора NSI-доменов, присутствует при положительном ответе, обычно является хешем

Пример запроса:

https://api.reg.ru/api/regru2/domain/register_ns?username=test&password=test&output_format=json&dname=test.com&ns0=ns0.test.com&ns0ip=1.2.3.4

Пример успешного ответа:

{
    answer => {
        resp => {
            actionstatusdesc => 'Addition Completed Successfully',
            status           => 'success',
            description      => 'test.com',
            actiontypedesc   => 'Addition of Child Nameserver ns0.test.com with IP [1.2.3.4]',
            actionstatus     => 'success',
            actiontype       => 'AddCns',
        },
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

7.15. Функция: domain/delete_ns

Назначение:

удаление домена из NSI-registry, поддерживаются только для международных доменов

Доступность:

все

Поля запроса:

Поле	Описание
domain_name	домен, nameserver которого будет удаляться
ns0	nameserver
ns0ip	IP адрес удаляемого nameserver-а

Поддержка обработки списка услуг:

нет

Поля ответа:

Поле	Описание
resp	детализированный ответ регистратора NSI-доменов, присутствует при положительном ответе, обычно является хешем

Пример запроса:

https://api.reg.ru/api/regru2/domain/delete_ns?username=test&password=test&output_format=json&dname=test.com&ns0=ns0.test.com&ns0ip=1.2.3.4

Пример успешного ответа:

{
    answer => {
        resp => {
            actionstatusdesc => 'Modification Completed Successfully',
            status           => 'success',
            description      => 'test.com',
            actiontypedesc   => 'Deletion of IP Address [1.2.3.4] from Child Nameserver ns0.test.com',
            actionstatus     => 'success',
            actiontype       => 'DelCnsIp',
        },
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

7.16. Функция: domain/get_nss

Назначение:

Получение DNS для доменов

Доступность:

клиенты

Поля запроса:

Cтандартные параметры идентификации услуги,
cтандартные параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов с параметрами dname, service_id и nss, или error_code c кодом ошибки идентификации услуги
nss	список DNS с параметрами ns и ip, если он был указан ранее

Примеры запросов:

Один домен

https://api.reg.ru/api/regru2/domain/get_nss?username=test&password=test&domain_name=test.ru

Несколько доменов

https://api.reg.ru/api/regru2/domain/get_nss?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.su"}]}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                nss        => [
                    {
                        ns => 'ns1.reg.ru'
                    },
                    {
                        ns => 'ns2.reg.ru'
                    }
                ],
                service_id => 12345
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

7.17. Функция: domain/update_nss

Назначение:

Изменение DNS серверов домена,
установка/снятие делегирования домена (только для партнёров)

Доступность:

клиенты

Поля запроса:

Поле	Описание
domain_name	Имя домена
ns0...ns3	Имена DNS серверов в порядке убывания приоритета
ns0ip...ns3ip	IP адреса DNS серверов. Необязательные поля. Используются только если имя DNS сервера содержит имя регистрируемого домена
nss	Хеш, содержащий список NS-серверов и, если надо, IP адресов. В ключами хеша будут поля ns0...ns3 и ns0ip...ns3ip, описанные выше. Только для запросов в JSON/XML формате
undelegate	Установка/снятие домена с делегирования. 0 - Делегировать, 1 - Снять делегирование

Так же см. параметры идентификации списка услуг.
Примечание:
Для поддержки DNS могут быть бесплатно использованы сервера REG.RU. Для этого в качестве DNS-серверов необходимо указать сервера ns1.reg.ru и ns2.reg.ru. В этом случае на серверах REG.RU будет прописана зона для Вашего домена. Управлять зоной можно через web-интерфейс сайта REG.RU или через API.

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов с параметрами dname и service_id, или error_code c кодом ошибки идентификации услуги

Примеры запросов:

Изменение DNS одного домена

https://api.reg.ru/api/regru2/domain/update_nss?username=test&password=test&dname=test.ru&ns0=ns1.test.com&ns0ip=1.2.3.4&ns1=ns2.test.com&ns1ip=2.3.4.5

Изменение DNS у списка доменов, один из которых содержит ошибку в названии (ответ для такого случая см. ниже)

https://api.reg.ru/api/regru2/domain/update_nss?username=test&password=test&input_format=json&input_data={"domains":[{"dname":"test.ru"},{"dname":"test.su"},{"dname":"----.ru"}],"nss":{"ns0":"ns1.reg.ru","ns1":"ns2.reg.ru"}}

Снятие домена с делегирования без передачи NS-серверов

https://api.reg.ru/api/regru2/domain/update_nss?username=test&password=test&domain_name=test.ru&undelegate=1

Примеры успешных ответов:

Один домен

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Несколько доменов, один из которых содержит ошибочные данные:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.su',
                service_id => 12346,
                result     => 'success'
            },
            {
                dname      => '----.ru',
                result     => 'domain_name is invalid or unsupported zone',
                error_code => 'INVALID_DOMAIN_NAME_FORMAT'
            }
        ]
    },
    result => 'success'
}

Успешный ответ смены флага делигирования домена без NS-серверов (запрос см. выше)

{
    answer     => {
        services => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            }
        ]
    },
    result     => 'success',
}

Возможные ошибки:

Error_code	Error_text	Описание
INVALID_NSS	Invalid nameservers	Сервера имен указаны неверно
NSS_NOT_FOUND	Name servers list not found	Список NS-серверов не найден

Cм. cтандартные коды ошибок

7.18. Функция: domain/delegate

Назначение:

Установка флага делегирования домена

Доступность:

партнёры

Поля запроса:

Cтандартные параметры идентификации услуги,
cтандартные параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
services	список услуг с параметрами dname и service_id, или error_code c кодом ошибки идентификации услуги

Пример запроса:

https://api.reg.ru/api/regru2/domain/delegate?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.su"}]}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.su',
                service_id => 12346,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

7.19. Функция: domain/undelegate

Назначение:

Снятие флага делегирования домена

Доступность:

партнёры

Поля запроса:

Cтандартные параметры идентификации услуги,
cтандартные параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
services	список услуг с параметрами dname и service_id, или error_code c кодом ошибки идентификации услуги

Пример запроса:

https://api.reg.ru/api/regru2/domain/undelegate?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.su"}]}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.su',
                service_id => 12346,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

7.20. Функция: domain/transfer_to_another_account

Назначение:

Полная передача домена на другой аккаунт

Доступность:

партнёры

Поля запроса:

Поле	Описание
new_user_name	login клиента, на который передаются домены
set_me_as_referrer	назначить себя рефералом для передаваемого домена (подробнее — см. Реферальная программа), допустимые значения 0 и 1

А так же cтандартные параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов, для которых передаются на другой аккаунт; в случае успешного выполнения запроса на передачу поле result будет содержать request_is_sent для каждого домена, иначе — код ошибки

Пример запроса:

https://api.reg.ru/api/regru2/domain/transfer_to_another_account?username=test&password=test&dname=test.ru.ru&dname=test.su&new_user_name=not_test

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'request_is_sent'
            },
            {
                dname      => 'test.su',
                service_id => 12346,
                error_code => 'NOT_TRANSFERED_DOMAIN_STATUS'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Error_code	Error_text	Описание
OPERATION_FOR_SERVISE_OWNER_ONLY	Only owner can have access to this function	Только владелец имеют доступ к этой функции
NOT_TRANSFERED_DOMAIN_STATUS	The status of the domain doesn't admit transfer, probably at first it is necessary to prolong the domain	Статус домена не допускает переноса, возможно сначала надо продлить домен

Cм. cтандартные коды ошибок

7.21. Функция: domain/look_at_entering_list

Назначение:

просмотр передаваемых на аккаунт доменов

Доступность:

партнёры

Поля запроса:

нет

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
messages	Список сообщений о передаче доменов, каждое сообщение содержит свой идентификатор id и имя передаваемого домена domain_name, для любой повторной передачи домена идентификатор будет иметь новое значение

Пример запроса:

https://api.reg.ru/api/regru2/domain/look_at_entering_list?username=test&password=test

Пример успешного ответа:

{
    answer => {
        messages => [
            {
                domain_name => 'test.ru',
                id          => 123456
            },
            {
                domain_name => 'test.su',
                id          => 123457
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

7.22. Функция: domain/accept_or_refuse_entering_list

Назначение:

Принять или отклонить передаваемые на этот аккаунт домены

Доступность:

партнёры

Поля запроса:

Поле	Описание
domain_name	имя получаемого домена
id	идентификатор сообщения о передаче домена, получить идентификатор можно при помощи функции domain/look_at_entering_list
action_type	тип действия по данному домену: принять домен accept или отказаться refuse, так же допустимы значения yes и no, 1 и 0

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	Список доменов c результатом действий по каждому домену

Примеры запросов:

https://api.reg.ru/api/regru2/domain/accept_or_refuse_entering_list?username=test&password=test&dname=test.ru&id=123456&action_type=accept

http://www1.reg.ru/api/regru2/domain/accept_or_refuse_entering_list?username=test&password=test&input_format=json&input_data={"domains":[{"dname":"test.ru","id":"123456","action_type":"yes"},{"dname":"test.su","id":"123457","action_type":"refuse"},{"dname":"test.com","id":"123458","action_type":"xxx"}]}

Примеры успешного ответа:

{
    answer => {
        domains => [
            {
                domain_name => 'test.ru',
                id          => 123456,
                action_type => 'accept',
                result      => 'accepted'
            },
        ]
    },
    result => 'success'
}

{
    answer => {
        domains => [
            {
                domain_name => 'test.ru',
                id          => 123456,
                action_type => 'yes',
                result      => 'accepted'
            },
            {
                domain_name => 'test.su',
                id          => 123457
                action_type => 'refuse',
                result      => 'refused'
            },
            {
                domain_name  => 'test.com',
                id           => 123458
                action_type  => 'xxx',
                result       => 'action_type has incorrect format or data',
                error_params => {
                    param => 'action_type'
                },
                error_code  => 'PARAMETER_INCORRECT'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

7.23. Функция: domain/cancel_transfer

Назначение:

Отменить перенос домена

Доступность:

партнёры

Поля запроса:

стандартные параметры идентификации услуги,
параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	Список доменов c результатом действий по каждому домену

Примеры запросов:

https://api.reg.ru/api/regru2/domain/cancel_transfer?username=test&password=test&dname=test.ru

http://www1.reg.ru/api/regru2/domain/cancel_transfer?username=test&password=test&input_format=json&input_data={"domains":[{"dname":"test.ru"]}

Примеры успешного ответа:

{
   "answer" : {
      "dname" : "test.com",
      "service_id" : "12345"
   },
   "result" : "success"
}

{
    answer => {
        domains => [
            {
		dname	   => 'test.com',
		service_id => 12345,
		result	   => 'success'
            },
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

8. Функции для управления DNS-зоной (категория zone)

8.1. Функция: zone/nop

Назначение:

для тестирования, позволяет проверить доступность управления DNS-зоной доменов; управление DNS-зоной возможно только если домену прописаны DNS сервера REG.RU

Доступность:

клиенты

Поля запроса:

стандартные параметры идентификации услуги,
параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов, где для доменов у которых можно управлять зоной поле result будет иметь значение success, иначе — код ошибки указывающий причину

Пример запроса:

https://api.reg.ru/api/regru2/zone/nop?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.com"}]}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.com',
                service_id => 12346,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

8.2. Функция: zone/add_alias

Назначение:

cвязать поддомен с IP-адресом

Доступность:

клиенты

Поля запроса:

Поле	Описание
subdomain	Имя поддомена, которому назначается IP-адрес. Чтобы назначить IP-адрес самому домену, передайте значение '@', чтобы назначить IP-адрес всем поддоменам, не обозначенным явно в других записях, передайте '*'.
ipaddr	IP-адрес, назначаемый поддомену.

А также стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов c результатами выполнения запроса

Пример запроса:

Доменам test.ru и test.com надо назначить IP-адрес 111.111.111.111

https://api.reg.ru/api/regru2/zone/add_alias?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.com"}],"subdomain":"@","ipaddr":"111.111.111.111"}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.com',
                service_id => 12346,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

8.3. Функция: zone/add_aaaa

Назначение:

cвязать поддомен с IPv6-адресом

Доступность:

клиенты

Поля запроса:

Поле	Описание
subdomain	Имя поддомена, которому назначается IPv6-адрес. Чтобы назначить IP-адрес самому домену, передайте значение '@', чтобы назначить IP-адрес всем поддоменам, не обозначенным явно в других записях, передайте '*'.
ipaddr	IPv6-адрес, назначемый поддомену.

А также стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов c результатами выполнения запроса

Пример запроса:

Доменам test.ru и test.com надо назначить IPv6-адрес aa11::a111:11aa:aaa1:aa1a

https://api.reg.ru/api/regru2/zone/add_aaaa?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.com"}],"subdomain":"@","ipaddr":"aa11::a111:11aa:aaa1:aa1a"}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.com',
                service_id => 12346,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

8.4. Функция: zone/add_cname

Назначение:

cвязать поддомен с адресом другого домена

Доступность:

клиенты

Поля запроса:

Поле	Описание
subdomain	Имя поддомена, которому назначается адрес
canonical_name	Имя домена, которому назначаются синонимы

А также стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов c результатами выполнения запроса

Пример запроса:

Домены 3-го уровня mail.test.ru и mail.test.com должны быть связаны с mx10.test.ru

https://api.reg.ru/api/regru2/zone/add_cname?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.com"}],"subdomain":"mail","canonical_name":"mx10.test.ru"}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.com',
                service_id => 12346,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Error_code	Error_text	Описание
CNAME_INVALID	Invalid CNAME	Неверное имя для CNAME
CNAME_ANDOTHERDATA	For this CNAME have other data already	Для этого CNAME уже есть другие данные

Cм. cтандартные коды ошибок

8.5. Функция: zone/add_mx

Назначение:

указать почтовый сервер в виде доменного имени или IP-адреса, который будет принимать почту для вашего домена

Доступность:

клиенты

Поля запроса:

Поле	Описание
subdomain	Имя поддомена, которому назначается адрес, по умолчанию подразумевается сам домен, т.е. значение @
priority	приоритет почтового сервера, 0 — высший, 10 — минимальный, значение по умолчанию 0
mail_server	Имя домена или IP-адрес почтового сервера (желательно вводить имя домена, т.к. не все почтовые сервера могут понимать IP-адрес)

А также стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов c результатами выполнения запроса

Пример запроса:

Назначить доменным зонам test.ru и test.com главными почтовые сервера mail.test.ru и mail.test.com

https://api.reg.ru/api/regru2/zone/add_mx?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.com"}],"subdomain":"@","mail_server":"mail"}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.com',
                service_id => 12346,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Error_code	Error_text	Описание
MAILHOST_INVALID	Error in mail_server IP address or domain name	Некорректно указан IP адрес или имя домена в поле mail_server

Cм. cтандартные коды ошибок

8.6. Функция: zone/add_ns

Назначение:

передать управление поддоменами на другие DNS-сервера

Доступность:

клиенты

Поля запроса:

Поле	Описание
subdomain	Имя поддомена, который будет управляться другими DNS-серверами
dns_server	Доменное имя DNS-сервера
record_number	Порядковый номер NS-записи, который будет определять относительное расположение NS-записей для поддомена

А также стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов c результатами выполнения запроса

Пример запроса:

Передать управление доменным зонам tt.test.ru и tt.test.com на DNS-сервер ns1.test.ru

https://api.reg.ru/api/regru2/zone/add_ns?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.com"}],"subdomain":"tt","dns_server":"ns1.test.ru","record_number":"10"}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.com',
                service_id => 12346,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Error_code	Error_text	Описание
NSADDR_INVALID	Invalid DNS-server address	Неверный адрес DNS-сервера

Cм. cтандартные коды ошибок

8.7. Функция: zone/add_txt

Назначение:

добавить произвольную текстовую запись (TXT) для поддомена

Доступность:

клиенты

Поля запроса:

Поле	Описание
subdomain	Имя поддомена, для которого добавляется текстовая запись
text	текст, допустимо использовать только алфавитноцифровые символы из набора ASCII

А также стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов c результатами выполнения запроса

Пример запроса:

Добавить комментарии для mail.test.ru и mail.test.com

https://api.reg.ru/api/regru2/zone/add_txt?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.com"}],"subdomain":"mail","text":"testmail"}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.com',
                service_id => 12346,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Error_code	Error_text	Описание
TEXT_NOT_FOUND	Text for record not found	Текст не найден
TEXT_TOOLONG	Text too long	Превышен лимит длинны строки

Cм. cтандартные коды ошибок

8.8. Функция: zone/add_srv

Назначение:

добавить сервисную запись

Доступность:

клиенты

Поля запроса:

Поле	Описание
service	сервис, который будет сопоставлен указанному серверу, например для назначения SIP серверу sip.test.ru по upd протоколу надо прописать _sip._udp
priority	приоритет записи
weight	нагрузка, которую могут обработать системы, необязательное поле, значение по умолчанию 0
target	сервер обслуживающий службу
port	порт обслуживающий службу

А также стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов c результатами выполнения запроса

Пример запроса:

Направить обслуживание SIP протокола для звонков на xxx@test.ru и xxx@test.com на сервер sip.test.ru по udp протоколу на 5060 порту

https://api.reg.ru/api/regru2/zone/add_srv?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.com"}],"service":"_sip._udp","priority":"0","port":"5060","target":"sip.test.ru"}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.com',
                service_id => 12346,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Error_code	Error_text	Описание
SERVICE_INVALID	Service not found or have incorrect data	Поле service не найдено или содержит некорректные данные
PRIORITY_INVALID	Priority not found or have not digital data	Поле priority не определено или содержит нецифровые данные
WEIGHT_INVALID	Weight have not digital data	Поле weight содержит нецифровые данные
PORT_INVALID	Port not found or have not digital data	Поле port не определено или содержит нецифровые данные

Cм. cтандартные коды ошибок

8.9. Функция: zone/get_resource_records

Назначение:

получение ресурсных записей зоны для каждого домена

Доступность:

клиенты

Поля запроса:

стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов, где для доменов у которых можно управлять зоной поле result будет иметь значение success, иначе — код ошибки указывающий причину
rrs	Ресурсные записи домена
subname	поддомен для которого создана ресурсная запись: * для всех поддоменов кроме указанных явно, @ для самого домена, или конкретное имя поддомена
rectype	класс, тип записи: A, AAAA, CNAME, MX, NS и другие
state	статус записи: N — неактивна (обычно сразу после добавления, но ещё до активации); A — активна; D — помечена к удалению
priority	приоритет записи
content	содержимое записи: IP адрес для А, IPv6 адрес для АААА, и др
soa	Время жизни кеша зоны

Пример запроса:

https://api.reg.ru/api/regru2/zone/get_resource_records?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.com"}]}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                rrs        => [
                    {
                        subname => 'www',
                        content => '111.222.111.222',
                        prio    => '0',
                        rectype => 'A',
                        state   => 'A'
                    }
                ],
                service_id => 12345,
                soa        => {
                    ttl         => '1d',
                    minimum_ttl => '12h'
                },
                result     => 'success'
            },
            {
                dname      => 'test.com',
                rrs        => [
                    {
                        subname => 'www',
                        content => '111.222.111.222',
                        prio    => '0',
                        rectype => 'A',
                        state   => 'A'
                    }
                ],
                service_id => 12346,
                soa        => {
                    ttl         => '1d',
                    minimum_ttl => '12h'
                },
                result => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

8.10. Функция: zone/update_records

Назначение:

добавление и/или удаление нескольких ресурсных записей одним запросом, порядок элементов в передаваемом массиве имеет значение т.к. одни записи могут быть зависимыми от других, в случае возникновения ошибки в одной из записей из action_list, последующиее игнорируются.

Доступность:

партнёры

Поля запроса:

Поле

Описание

action_list

Массив хешей, где каждый хеш содержит параметры для добавления/удаления ресурсной записи. Класс/тип добавляемой записи указывает поле action, допустимые варианты: add_alias, add_aaaa, add_cname, add_mx, add_ns, add_txt, add_srv, remove_record. Остальные поля хеша зависят от action и соответствуют функциям, описанным выше. Для примера, приведённого ниже, структура action_list будет иметь следующий вид: action_list => [ { action => 'add_alias', subdomain => 'www', ipaddr => '11.22.33.44' }, { action => 'add_cname', subdomain => '@', canonical_name => 'www.test.ru' } ] Массив action_list может быть как общим для всего списка доменов (см. 1-й пример запроса), так и особым для каждого домена в списке (см. 2й пример запроса).

А также стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов c результатами выполнения запроса

Примеры запросов:

Указать адрес 11.22.33.44 домену www.test.ru и назначить ему синоним test.ru

https://api.reg.ru/api/regru2/zone/update_records?input_format=json&input_data={"username":"test","password":"test","domain_name":"test.ru","action_list":[{"action":"add_alias","subdomain":"www","ipaddr":"11.22.33.44"},{"action":"add_cname","subdomain":"@","canonical_name":"www.test.ru"}]}

Тоже самое, но в виде списка и в названии первого действия допущена ошибка.

https://api.reg.ru/api/regru2/zone/update_records?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru","action_list":[{"action":"add_aalias","subdomain":"www","ipaddr":"11.22.33.44"},{"action":"add_cname","subdomain":"@","canonical_name":"www.test.ru"}]}]}

Примеры ответов:

Успешный ответ на первый запрос:

{
    answer => {
        domains => [
            {
                dname       => 'test.ru',
                service_id  => 12345,
                action_list => [
                    {
                        action => 'add_alias',
                        result => 'success'
                    },
                    {
                        action => 'add_cname',
                        result => 'success'
                    }
                ],
                result      => 'success'
            }
        ]
    },
    result => 'success'
}

Ответ на второй запрос, содержащий ошибку:

{
    answer => {
        domains => [
            {
                dname        => 'test.ru',
                service_id   => 12345,
                error_params => {
                    action => 'add_aalias'
                },
                error_code   => 'INVALID_ACTION',
                error_text   => 'Invalid action: add_aalias'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Error_code	Error_text	Описание
INVALID_ACTION	Action is invalid or not found	Действие ошибочно или не найдено

Cм. cтандартные коды ошибок

8.11. Функция: zone/update_soa

Назначение:

изменить время жизни кеша для зоны

Доступность:

клиенты

Поля запроса:

Поле	Описание
ttl	Время жизни кеша для зоны. Либо число в секундах, либо число с суффиксами m для месяцев, w для недель, d для дней, h для часов
minimum_ttl	Время жизни кеша для негативного ответа на запрос в зонe. Формат поля как и в TTL

А также стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов c результатами выполнения запроса

Пример запроса:

https://api.reg.ru/api/regru2/zone/update_soa?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.com"}],"ttl":"1d","minimum_ttl":"4h"}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.com',
                service_id => 12346,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Error_code	Error_text	Описание
SOA_RECORD_INVALID	Invalid time for SOA record	Некорректно указано время для SOA-записи

Cм. cтандартные коды ошибок

8.12. Функция: zone/tune_forwarding

Назначение:

добавить ресурсные записи, необходимые для web-форвардинга

Доступность:

клиенты

Поля запроса:

стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов c результатами выполнения запроса

Пример запроса:

https://api.reg.ru/api/regru2/zone/tune_forwarding?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.com"}]}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.com',
                service_id => 12346,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

8.13. Функция: zone/clear_forwarding

Назначение:

удалить ресурсные записи, необходимые для web-форвардинга

Доступность:

клиенты

Поля запроса:

стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов c результатами выполнения запроса

Пример запроса:

https://api.reg.ru/api/regru2/zone/clear_forwarding?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.com"}]}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.com',
                service_id => 12346,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

8.14. Функция: zone/tune_parking

Назначение:

добавить ресурсные записи, необходимые для парковки домена

Доступность:

клиенты

Поля запроса:

стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов c результатами выполнения запроса

Пример запроса:

https://api.reg.ru/api/regru2/zone/tune_parking?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.com"}]}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.com',
                service_id => 12346,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

8.15. Функция: zone/clear_parking

Назначение:

удалить ресурсные записи, необходимые для парковки домена

Доступность:

клиенты

Поля запроса:

стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов c результатами выполнения запроса

Пример запроса:

https://api.reg.ru/api/regru2/zone/clear_parking?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.com"}]}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.com',
                service_id => 12346,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

8.16. Функция: zone/remove_record

Назначение:

удалить ресурсную запись

Доступность:

клиенты

Поля запроса:

Поле	Описание
subdomain	поддомен для которого будет удаляться запись, обязательное поле
record_type	класс, тип удаляемой записи, обязательное поле
priority	приоритет записи, опциональное поле, значение по умолчанию 0
content	содержимое записи, опциональное поле, при его отсутствии помечаются к удалению все записи, попадающие под условие остальных параметров

А также стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов c результатами выполнения запроса

Пример запроса:

https://api.reg.ru/api/regru2/zone/remove_record?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.com"}],"subdomain":"@","content":"111.111.111.111","record_type":"A"}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.com',
                service_id => 12346,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

8.17. Функция: zone/clear

Назначение:

удалить все ресурсные записи

Доступность:

клиенты

Поля запроса:

стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
domains	список доменов c результатами выполнения запроса

Пример запроса:

https://api.reg.ru/api/regru2/zone/clear?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"test.ru"},{"dname":"test.com"}]}

Пример успешного ответа:

{
    answer => {
        domains => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                result     => 'success'
            },
            {
                dname      => 'test.com',
                service_id => 12346,
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

9. Функции для работы с услугами (категория service)

9.1. Функция: service/nop

Назначение:

для тестирования, позволяет проверить доступность списка услуг и получить их id

Доступность:

клиенты

Поля запроса:

стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
service_id	идентификатор услуги, если переданы dname+servtype

Пример запроса:

https://api.reg.ru/api/regru2/service/nop?username=test&password=test&domain_name=test.ru

Пример успешного ответа:

{
    answer => {
        services => [
            {
                dname      => 'test.ru',
                service_id => 12345,
                servtype   => 'domain',
                result     => 'success'
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

9.2. Функция: service/get_servtype_details

Назначение:

Получение цены и общих данных для услуги.

Доступность:

Все.

Поля запроса:

Поле	Описание
servtype	Вид услуги: srv_webfwd — «Web-форвардинг», srv_parking — «Парковка домена», srv_dns_both — «Поддержка DNS», srv_hosting_ispmgr — «Хостинг», srv_certificate — «Сертификат на домен», srv_voucher — «Свидетельство на домен», srv_kvm — «KVM доступ».
subtype	Подтип услуги
unroll_prices	Показывать цены в развернутом виде

Примечание:
Чтобы получить цены для нескольких видов услуг, можно указать их в поле servtype через запятую или передать в запросе несколько полей servtype. В этом случае поле subtype игнорируется.

Поля ответа:

Список подтипов услуги. Каждый элемент списка содержит поля:

Поле	Описание
servtype	Вид услуги
subtype	Подтип услуги
unit	Единица измерения для периода "YEAR" или "MONTH"
extparams	Дополнительные параметры
is_renewable	1 - возможно продление 0 - услуга без продления
commonname, middlename, title_new_rus, title_new_eng, title_renew_rus, title_renew_eng	Различные форматы описания

Дополнительные поля, при вызове функции с отсутствующим или нулевым параметром unroll_prices:

Поле	Описание
periods_new	Диапазон возможных сроков регистрации
periods_renew	Диапазон возможных сроков продления
price_new	Цена заказа сервиса
price_renew	Цена продления сервиса

Дополнительные поля при вызове функции с параметром unroll_prices=1:

Поле	Описание
prices_new	Список периодов и цен для заказа услуги
prices_renew	Список периодов и цен для продления услуги

Пример запроса:

http://api.reg.ru/api/regru2/service/get_servtype_details?username=test&password=test&servtype=srv_hosting_ispmgr&unroll_prices=1

Пример успешного ответа:

{
   "answer" : [
      {
         "commonname" : "Web-forwarding",
         "title_new_rus" : "Web-forwarding[% IF dname %] для домена [% dname %][% END %] [% p_rus %]",
         "periods_renew" : "1-10",
         "middlename" : "Web-forwarding [% ru ? \"для\" : \"for\"%] [% dname %]",
         "title_renew_rus" : "Продление web-forwarding для домена [% dname %] [% p_rus %]",
         "title_new_eng" : "Web-forwarding[% IF dname %] for [% dname %][% END %] [% p_eng %]",
         "subtype" : "",
         "unit" : "year",
         "extparams" : {},
         "periods_new" : "1-10",
         "is_renewable" : "1",
         "price_renew" : "120.00",
         "title_renew_eng" : "Prolongation of web-forwarding for [% dname %] domain [% p_eng %]",
         "servtype" : "srv_webfwd",
         "price_new" : "120.00"
      }
   ],
   "result" : "success"
}

Возможные ошибки:

Cм. cтандартные коды ошибок

9.3. Функция: service/create

Назначение:

заказ новой услуги.

Доступность:

все пользователи

Поля запроса:

Параметр	Описание
Общие
domain_name	Имя домена, для которого заказывается услуга.
servtype	Вид заказываемой услуги: srv_webfwd — «Web-форвардинг», srv_parking — «Парковка домена», srv_dns_both — «Поддержка DNS», srv_hosting_ispmgr — «ISPManager хостинг», srv_hosting_cpanel — «CPanel хостинг», srv_hosting_plesk — «PLesk хостинг», srv_hosting_dctadm — «DirectAdmin хостинг», srv_ssl_certificate — «SSL сертификат», srv_certificate — «Сертификат на домен», srv_voucher — «Свидетельство на домен», srv_vps — «VPS сервер», srv_license_isp — «Лицензия ISP Manager», srv_addip — «Дополнительный IP», srv_antispam — «Расширенная защита от спама», srv_dedicated — «Выделенный сервер», srv_kvm — «KVM доступ».
period	Срок, на который заказывается услуга, единица измерения (год или месяц) зависит от вида заказываемой услуги. Значения единиц измерения для различных услуг Вы можете получить с помощью функции service/get_servtype_details.
user_servid	ID домена, задаваемый пользователем. Допустимые символы: цифры 0..9 и латинские буквы a..f, длина поля 32 символа. Автоматически идентификатор не создаётся, т.е. если он не был задан при создании услуги, то поле остаётся пустым. Необязательное поле.
Параметры оплаты (необязательны)
point_of_sale pay_type ok_if_no_money	См. Общие параметры оплаты.
Прочие общие параметры (необязательны)
folder_name или folder_id	Задает название папки, куда будут добавлены услуги. (см. стандартные параметры идентификации папок)
no_new_folder	Если указано имя несуществующей папки: 0 — (по-умолчанию) — Создавать новую папку. 1 — Не создавать папку, возвращать код ошибки. Необязательное поле.
comment	Комментарий - любая строка описывающая заказ. Необязательное поле.
admin_comment	Комментарий для администраторов — любая строка описывающая заказ. Необязательное поле.
ISPManager хостинг (srv_hosting_ispmgr)
plan (deprecated)	Тарифный план, сейчас доступны: "Host-0-0910", "Host-1-1209", "Host-2-1209", "Host-3-1209", "Host-CMS-1209", "Host-Lite-0910". Для указания тарифного плана рекомендуется использовать параметр "subtype"
subtype	Т Тарифный план, сейчас доступны: "Host-0-0910", "Host-1-1209", "Host-2-1209", "Host-3-1209", "Host-CMS-1209", "Host-Lite-0910". Для указания тарифного плана рекомендуется использовать параметр "subtype"
contype	Тип контактных данных. Принимает значение "hosting_pp" при регистрации сервера на данные физического лица и значение "hosting_org" при регистрации сервера на данные юридического лица.
email	e-mail-адрес для создаваемого хостинг-аккаунта.
phone	Телефон. Необязательное поле
country	Двухбуквенный ISO-код страны, в которой зарегистрировано(а) физическое лицо (организация).
person_r	Указывается при использовании параметра "contype" со значением "hosting_pp". Фамилия, имя и отчество администратора сервера на русском языке в соответствии с паспортными данными. Для иностранцев поле содержит имя в оригинальном написании (при невозможности в английской транслитерации). Пример1: Пупкин Василий Николаевич Пример2: John Smith
passport	Указывается при использовании параметра "contype" со значением "hosting_pp". Серия и номер паспорта, а также наименование органа, выдавшего паспорт, и дата выдачи (в указанной последовательности, с разделением пробелами). В написании римских цифр допустимо использование только латинских букв. Дата записывается в формате ДД.ММ.ГГГГ. Знак номера перед номером паспорта не ставится. Паспорта СССР (паспорта старого образца) не принимаются. В случае использования документа, отличного от паспорта (допустимо ТОЛЬКО для нерезидентов России), в начале строки указывается наименование вида документа. Запись может быть многострочной. Пример: 34 02 651241 выдан 48 о/м г.Москвы 26.12.1990
pp_code	Указывается при использовании параметра "contype" со значением "hosting_pp". Идентификационный номер налогоплательщика (ИНН). Запись может содержать пустую строку, если администратором является нерезидент РФ, не имеющий идентификационного номера налогоплательщика. Необязательное поле. Пример: 7701107259
org_r	Указывается при использовании параметра "contype" со значением "hosting_org". Полное наименование организации-администратора домена на русском языке в соответствии с учредительными документами. Для нерезидентов указывается написание на национальном языке (либо на английском языке). Запись может быть многострочной. Пример1: Урюпинский государственный университет\nимени Карлы-Марлы Пример2: Общество с ограниченной ответственностью "Рога и Копыта"
code	Указывается при использовании параметра "contype" со значением "hosting_org". Идентификационный номер налогоплательщика (ИНН), присвоенный организации-администратору. Запись может содержать пустую строку, если администратором является нерезидент РФ, не имеющий идентификационного номера налогоплательщика. Пример: 7701107259
Cpanel хостинг (srv_hosting_cpanel)
subtype	Тарифный план, сейчас доступны: "Host-0", "Host-1", "Host-2", "Host-3", "Host-CMS".
contype	Тип контактных данных. Принимает значение "hosting_pp" при регистрации сервера на данные физического лица и значение "hosting_org" при регистрации сервера на данные юридического лица.
email	e-mail-адрес для создаваемого хостинг-аккаунта.
phone	Телефон. Необязательное поле
country	Двухбуквенный ISO-код страны, в которой зарегистрировано(а) физическое лицо (организация).
person_r	Указывается при использовании параметра "contype" со значением "hosting_pp". Фамилия, имя и отчество администратора сервера на русском языке в соответствии с паспортными данными. Для иностранцев поле содержит имя в оригинальном написании (при невозможности в английской транслитерации). Пример1: Пупкин Василий Николаевич Пример2: John Smith
passport	Указывается при использовании параметра "contype" со значением "hosting_pp". Серия и номер паспорта, а также наименование органа, выдавшего паспорт, и дата выдачи (в указанной последовательности, с разделением пробелами). В написании римских цифр допустимо использование только латинских букв. Дата записывается в формате ДД.ММ.ГГГГ. Знак номера перед номером паспорта не ставится. Паспорта СССР (паспорта старого образца) не принимаются. В случае использования документа, отличного от паспорта (допустимо ТОЛЬКО для нерезидентов России), в начале строки указывается наименование вида документа. Запись может быть многострочной. Пример: 34 02 651241 выдан 48 о/м г.Москвы 26.12.1990
pp_code	Указывается при использовании параметра "contype" со значением "hosting_pp". Идентификационный номер налогоплательщика (ИНН). Запись может содержать пустую строку, если администратором является нерезидент РФ, не имеющий идентификационного номера налогоплательщика. Необязательное поле. Пример: 7701107259
org_r	Указывается при использовании параметра "contype" со значением "hosting_org". Полное наименование организации-администратора домена на русском языке в соответствии с учредительными документами. Для нерезидентов указывается написание на национальном языке (либо на английском языке). Запись может быть многострочной. Пример1: Урюпинский государственный университет\nимени Карлы-Марлы Пример2: Общество с ограниченной ответственностью "Рога и Копыта"
code	Указывается при использовании параметра "contype" со значением "hosting_org". Идентификационный номер налогоплательщика (ИНН), присвоенный организации-администратору. Запись может содержать пустую строку, если администратором является нерезидент РФ, не имеющий идентификационного номера налогоплательщика. Пример: 7701107259
Plesk хостинг (srv_hosting_plesk)
subtype	Тарифный план, сейчас доступны: "Host-0-0311", "Host-1-0311", "Host-2-0311", "Host-3-0311", "Host-CMS-0311", "Host-Lite-0311", "Host-SB-0311".
contype	Тип контактных данных. Принимает значение "hosting_pp" при регистрации сервера на данные физического лица и значение "hosting_org" при регистрации сервера на данные юридического лица.
email	e-mail-адрес для создаваемого хостинг-аккаунта.
phone	Телефон. Необязательное поле
country	Двухбуквенный ISO-код страны, в которой зарегистрировано(а) физическое лицо (организация).
person_r	Указывается при использовании параметра "contype" со значением "hosting_pp". Фамилия, имя и отчество администратора сервера на русском языке в соответствии с паспортными данными. Для иностранцев поле содержит имя в оригинальном написании (при невозможности в английской транслитерация). Пример1: Пупкин Василий Николаевич Пример2: John Smith
passport	Указывается при использовании параметра "contype" со значением "hosting_pp". Серия и номер паспорта, а также наименование органа, выдавшего паспорт, и дата выдачи (в указанной последовательности, с разделением пробелами). В написании римских цифр допустимо использование только латинских букв. Дата записывается в формате ДД.ММ.ГГГГ. Знак номера перед номером паспорта не ставится. Паспорта СССР (паспорта старого образца) не принимаются. В случае использования документа, отличного от паспорта (допустимо ТОЛЬКО для нерезидентов России), в начале строки указывается наименование вида документа. Запись может быть многострочной. Пример: 34 02 651241 выдан 48 о/м г.Москвы 26.12.1990
pp_code	Указывается при использовании параметра "contype" со значением "hosting_pp". Идентификационный номер налогоплательщика (ИНН). Запись может содержать пустую строку, если администратором является нерезидент РФ, не имеющий идентификационного номера налогоплательщика. Необязательное поле. Пример: 7701107259
org_r	Указывается при использовании параметра "contype" со значением "hosting_org". Полное наименование организации-администратора домена на русском языке в соответствии с учредительными документами. Для нерезидентов указывается написание на национальном языке (либо на английском языке). Запись может быть многострочной. Пример1: Урюпинский государственный университет\nимени Карлы-Марлы Пример2: Общество с ограниченной ответственностью "Рога и Копыта"
code	Указывается при использовании параметра "contype" со значением "hosting_org". Идентификационный номер налогоплательщика (ИНН), присвоенный организации-администратору. Запись может содержать пустую строку, если администратором является нерезидент РФ, не имеющий идентификационного номера налогоплательщика. Пример: 7701107259
DirectAdmin хостинг (srv_hosting_dctadm)
subtype	Тарифный план, сейчас доступны: "Host-0", "Host-1", "Host-2", "Host-3", "Host-CMS", "Host-Lite".
contype	Тип контактных данных. Принимает значение "hosting_pp" при регистрации сервера на данные физического лица и значение "hosting_org" при регистрации сервера на данные юридического лица.
email	e-mail-адрес для создаваемого хостинг-аккаунта.
phone	Телефон. Необязательное поле
country	Двухбуквенный ISO-код страны, в которой зарегистрировано(а) физическое лицо (организация).
person_r	Указывается при использовании параметра "contype" со значением "hosting_pp". Фамилия, имя и отчество администратора сервера на русском языке в соответствии с паспортными данными. Для иностранцев поле содержит имя в оригинальном написании (при невозможности в английской транслитерации). Пример1: Пупкин Василий Николаевич Пример2: John Smith
passport	Указывается при использовании параметра "contype" со значением "hosting_pp". Серия и номер паспорта, а также наименование органа, выдавшего паспорт, и дата выдачи (в указанной последовательности, с разделением пробелами). В написании римских цифр допустимо использование только латинских букв. Дата записывается в формате ДД.ММ.ГГГГ. Знак номера перед номером паспорта не ставится. Паспорта СССР (паспорта старого образца) не принимаются. В случае использования документа, отличного от паспорта (допустимо ТОЛЬКО для нерезидентов России), в начале строки указывается наименование вида документа. Запись может быть многострочной. Пример: 34 02 651241 выдан 48 о/м г.Москвы 26.12.1990
pp_code	Указывается при использовании параметра "contype" со значением "hosting_pp". Идентификационный номер налогоплательщика (ИНН). Запись может содержать пустую строку, если администратором является нерезидент РФ, не имеющий идентификационного номера налогоплательщика. Необязательное поле. Пример: 7701107259
org_r	Указывается при использовании параметра "contype" со значением "hosting_org". Полное наименование организации-администратора домена на русском языке в соответствии с учредительными документами. Для нерезидентов указывается написание на национальном языке (либо на английском языке). Запись может быть многострочной. Пример1: Урюпинский государственный университет\nимени Карлы-Марлы Пример2: Общество с ограниченной ответственностью "Рога и Копыта"
code	Указывается при использовании параметра "contype" со значением "hosting_org". Идентификационный номер налогоплательщика (ИНН), присвоенный организации-администратору. Запись может содержать пустую строку, если администратором является нерезидент РФ, не имеющий идентификационного номера налогоплательщика. Пример: 7701107259
SSL сертификат (srv_ssl_certificate)
обязательные: org_org_name, org_address, org_city, org_state, org_postal_code, org_country, org_phone необязательные: org_first_name, org_last_name, org_fax	Название, имя, фамилия, адрес, город, штат(провинция), почтовый индекс, страна, телефон, факс организации. Используются для всех SSL сертификатов компаний Thawte, Comodo, VeriSign, а так-же для GeoTrust SSL сертификатов: True BusinessID, True BusinessID Wildcard, True BusinessID with EV.
обязательные: admin_first_name, admin_last_name, admin_title, admin_address, admin_city, admin_state, admin_postal_code, admin_country, admin_phone, admin_email, необязательные: admin_fax, admin_org_name	Имя, фамилия, должность, адрес, город, штат, почтовый индекс, страна, телефон, e-mail, факс, название организации адрес администратора. Используются для всех SSL сертификатов компаний Thawte, GeoTrust, Trustwave и VeriSign, а так-же для Comodo EV SSL сертификата.
обязательные: billing_first_name, billing_last_name, billing_title, billing_address, billing_city, billing_state, billing_postal_code, billing_country, billing_phone, billing_email, необязательные: billing_fax, billing_org_name	Имя, фамилия, должность, адрес, город, штат, почтовый индекс, страна, телефон, e-mail, факс, название организации адрес финансового менеджера. Используются для всех SSL сертификатов компаний Thawte, GeoTrust и VeriSign.
обязательные: tech_first_name, tech_last_name, tech_title, tech_address, tech_city, tech_state, tech_postal_code, tech_country, tech_phone, tech_email, необязательные: tech_fax, tech_org_name	Имя, фамилия, должность, адрес, город, штат, почтовый индекс, страна, телефон, e-mail, факс, название организации адрес технического специалиста. Используются для всех SSL сертификатов компаний Thawte, GeoTrust и VeriSign.
обязательные: signer_first_name, signer_last_name, signer_title, signer_address, signer_city, signer_state, signer_postal_code, signer_country, signer_phone, signer_email, необязательные: signer_fax, signer_org_name	Имя, фамилия, должность, адрес, город, штат, почтовый индекс, страна, телефон, e-mail, факс, название организации адрес ответственного за подписку SSL сертиификата. Используются для Comodo EV SSL сертификата.
approver_email	E-mail адрес для подтверждения сертификата.
server_type	Программное обеспечение. Возможные значения: Для Comodo SSL сертификатов: apachessl, citrix, domino, ensim, hsphere, iis4, iis6, iis7, iplanet, javawebserver, netscape, ibmhttp, novell, oracle, other, plesk, redhat, sap, tomcat, webstar, whmcpanel Для Thawte, GeoTrust и VeriSign SSL сертификатов: apache2 apacheopenssl apacheraven apachessl apachessleay c2net cobaltseries cobaltraq3 cobaltraq2 cpanel domino dominogo4626 dominogo4625 ensim hsphere iis iis4 iis5 iplanet ipswitch netscape ibmhttp other plesk tomcat weblogic website webstar webstar4 zeusv3 Для TrustWave SSL Сертификатов данный параметр не используется.
csrString	Закодированный CSR включая маркеры начала и окончания.
subtype	Вид сертификата. Возможные значения: Thawte: ssl123, sgcsuper_certs, sslwebserver, sslwebserver_wildcard, sslwebserver_ev Symantec: securesite, securesite_pro, securesite_ev, securesite_pro_ev GeoTrust: quickssl, quickssl_premium, truebizid, truebizid_wildcard, truebizid_ev TrustWave: trustwave_dv, trustwave_ev, trustwave_premiumssl, trustwave_premiumssl_wildcard Comodo: comodo_ev, comodo_instantssl, comodo_premiumssl, comodo_premiumssl_wildcard, comodo_ssl, comodo_wildcard
Сертификат на домен (srv_certificate) Свидетельство на домен (srv_voucher)
obtain_cert	способ получения сертификата: in_office — В офисе REG.RU дополнительные параметры: office, phone, remark free_mail — Почтой в любой город Российской Федерации (доставка бесплатная) дополнительные параметры: postcode, name, addr paid_mail — Почтой в любой другой город мира (доставка платная) дополнительные параметры: postcode, name, addr, city, country_code, state
office	Допустимые значения: moscow, samara, kiev, piter
phone	телефон в международном формате: знак "+", код страны, номер телефона.
remark	Примечание
p_postcode	Почтовый индекс для бесплатной отправки сертификата по России
p_addr	Адрес в России
p_name	Фамилия, Имя, Отчество по-русски
a_postcode	Почтовый индекс для международного письма
a_addr	Почтовый адрес для международного (только латиницей)
a_name	Полное имя для международного письма (только латиницей)
a_state	Область, штат
a_city	Город для международной отправки сертификата
a_country_code	Код страны (например UK)
VPS сервер (srv_vps)
subtype	Тарифный план, сейчас доступны: "VPS-1-1011", "VPS-2-1011", "VPS-3-1011", "VPS-4-1011".
vpsname	Наименование сервера для идентификации в списке услуг.
ostmpl	Шаблон предустановленной операционной системы. Сейчас доступны: "centos-x86", "centos-x86_64", "debian-x86", "debian-x86_64", "fedora-x86", "fedora-x86_64", "suse-x86", "suse-x86_64", "ubuntu-x86", "ubuntu-x86_64", "centos-x86_bitrix", "centos-x86_64_bitrix", "centos-x86_webmin", "centos-x86_64_webmin", "debian-x86_webmin", "debian-x86_64_webmin", "ubuntu-x86_webmin", "ubuntu-x86_64_webmin".
contype	Тип контактных данных. Принимает значение "pp" при регистрации сервера на данные физического лица и значение "org" при регистрации сервера на данные юридического лица.
email	e-mail адрес для создаваемого хостинг-аккаунта.
phone	Телефон. Необязательное поле
country	Двухбуквенный ISO-код страны, в которой зарегистрировано(а) физическое лицо (организация).
person_r	Указывается при использовании параметра "contype" со значением "pp". Фамилия, имя и отчество администратора сервера на русском языке в соответствии с паспортными данными. Для иностранцев поле содержит имя в оригинальном написании (при невозможности в английской транслитерации). Пример1: Пупкин Василий Николаевич Пример2: John Smith
passport	Указывается при использовании параметра "contype" со значением "pp". Серия и номер паспорта, а также наименование органа, выдавшего паспорт, и дата выдачи (в указанной последовательности, с разделением пробелами). В написании римских цифр допустимо использование только латинских букв. Дата записывается в формате ДД.ММ.ГГГГ. Знак номера перед номером паспорта не ставится. Паспорта СССР (паспорта старого образца) не принимаются. В случае использования документа, отличного от паспорта (допустимо ТОЛЬКО для нерезидентов России), в начале строки указывается наименование вида документа. Запись может быть многострочной. Пример: 34 02 651241 выдан 48 о/м г.Москвы 26.12.1990
org_r	Указывается при использовании параметра "contype" со значением "org". Полное наименование организации-администратора домена на русском языке в соответствии с учредительными документами. Для нерезидентов указывается написание на национальном языке (либо на английском языке). Запись может быть многострочной. Пример1: Урюпинский государственный университет\nимени Карлы-Марлы Пример2: Общество с ограниченной ответственностью "Рога и Копыта"
code	Указывается при использовании параметра "contype" со значением "org". Идентификационный номер налогоплательщика (ИНН), присвоенный организации-администратору. Запись может содержать пустую строку, если администратором является нерезидент РФ, не имеющий идентификационного номера налогоплательщика. Пример: 7701107259
Лицензия ISP Manager (srv_license_isp)
uplink_service_id	ID родительской услуги, к которой заказывается лицензия ISP Manager. Заказ лицензии возможен только для VPS (srv_vps).
subtype	Тип лицензии, доступны: "lite", "pro". Необязательный параметр, значение по умолчанию: "lite"
installation_way	Тип переустановки ОС на VPS. Принимает значение "auto" для автоматической переустановки ОС и значение "manual" только для заказа лицензии. Необязательный параметр, значение по умолчанию: "manual"
ostmpl	Шаблон предустановленной операционной системы. Необязательный параметр, может потребоваться в том случае если шаблон установленной ОС не поддерживается ISP Manager'ом. Поддерживаются следующие шаблоны ОС: "centos-x86", "centos-x86_64", "debian-x86", "debian-x86_64", "ubuntu-x86", "ubuntu-x86_64".
Дополнительный IP (srv_addip)
uplink_service_id	ID родительской услуги, к которой заказывается дополнительный IP. Заказ дополнительного IP возможен только для VPS (srv_vps), ISPManager хостинга (srv_hosting_ispmgr) и CPanel хостинга (srv_hosting_cpanel).
subtype	Т Тип дополнительного IP, доступны: "same_subnet" для заказа случайного доп. IP, "other_subnet" для заказа доп. IP находящегося в другой подсети класса C относительно основного адреса VPS-сервера. Обязательный параметр, значение по умолчанию: "same_subnet"
Расширенная защита от спама (srv_antispam)
uplink_service_id	ID родительской услуги, к которой заказывается расширенная защита от спама. Заказ расширенной защиты от спама возможен для домена (domain), ISPManager хостинга (srv_hosting_ispmgr), CPanel хостинга (srv_hosting_cpanel) и Plesk хостинга (srv_hosting_plesk).
dname	Имя домена для которого заказывается расширенная защита от спама. Данный параметр может быть использован как альтернатива uplink_service_id. Необязательный параметр.
spam_action	Данный параметр определяет какие действия будут применены к почте распознанной как спам. Возможны 2 варианта: "delete" ( Удалять найденный спам ), "mark" ( Отметить найденный спам email-заголовками X-Spam-* ). Необязательный параметр, значение по умолчанию: "delete".
mx_list	Список MX серверов через запятую, используемых для транспорта отфильтрованной почты.
Выделенный сервер (srv_dedicated)
server_name	Наименование сервера для идентификации в списке услуг.
server_id	Уникальный идентификатор сервера.
ostmpl	Шаблон предустановленной операционной системы. Сейчас доступны: "centos-x86", "centos-x86_64", "debian-x86", "debian-x86_64", "fedora-x86", "fedora-x86_64", "suse-x86", "suse-x86_64".
disk_layout	Описание разметки файловой системы (в свободной форме). Необязательный параметр.
client_comment	Ваши пожелания по установке сервера (в свободной форме). Необязательный параметр.
use_raid	Использование raid-массива (для серверов с raid-контроллером). Необязательный параметр.
contype	Тип контактных данных. Принимает значение "pp" при регистрации сервера на данные физического лица и значение "org" при регистрации сервера на данные юридического лица.
email	e-mail адрес для создаваемого хостинг-аккаунта.
phone	Телефон. Необязательное поле
country	Двухбуквенный ISO-код страны, в которой зарегистрировано(а) физическое лицо (организация).
person_r	Указывается при использовании параметра "contype" со значением "pp". Фамилия, имя и отчество администратора сервера на русском языке в соответствии с паспортными данными. Для иностранцев поле содержит имя в оригинальном написании (при невозможности в английской транслитерации). Пример1: Пупкин Василий Николаевич Пример2: John Smith
passport	Указывается при использовании параметра "contype" со значением "pp". Серия и номер паспорта, а также наименование органа, выдавшего паспорт, и дата выдачи (в указанной последовательности, с разделением пробелами). В написании римских цифр допустимо использование только латинских букв. Дата записывается в формате ДД.ММ.ГГГГ. Знак номера перед номером паспорта не ставится. Паспорта СССР (паспорта старого образца) не принимаются. В случае использования документа, отличного от паспорта (допустимо ТОЛЬКО для нерезидентов России), в начале строки указывается наименование вида документа. Запись может быть многострочной. Пример: 34 02 651241 выдан 48 о/м г.Москвы 26.12.1990
org_r	Указывается при использовании параметра "contype" со значением "org". Полное наименование организации-администратора домена на русском языке в соответствии с учредительными документами. Для нерезидентов указывается написание на национальном языке (либо на английском языке). Запись может быть многострочной. Пример1: Урюпинский государственный университет\nимени Карлы-Марлы Пример2: Общество с ограниченной ответственностью "Рога и Копыта"
code	Указывается при использовании параметра "contype" со значением "org". Идентификационный номер налогоплательщика (ИНН), присвоенный организации-администратору. Запись может содержать пустую строку, если администратором является нерезидент РФ, не имеющий идентификационного номера налогоплательщика. Пример: 7701107259
KVM доступ (srv_kvm)
uplink_service_id	ID родительской услуги, к которой заказывается KVM доступ. Заказ KVM доступа возможен только для выделеного сервера (srv_dedicated).

Поддержка обработки списка услуг:

нет

Поля ответа:

Поле	Описание
descr	Общее описание сделанного заказа.
bill_id	Номер счёта заказа.
payment	Цена заказа.
pay_notes	Результат проведения оплаты.
service_id	Числовой идентификатор услуги.
Яндекс.Почта
regruadd_url	Специальная ссылка. По данной ссылке клиент обязательно должен перейти на яндекс для активации почты.

Пример запроса:

https://api.reg.ru/api/regru2/service/create?username=test&password=test&dname=qqq.ru&servtype=srv_hosting_ispmgr&period=1&plan=Host-2-1209

Пример успешного ответа:

{
    'result' => 'success';
    'answer' => {
        'descr' => 'service srv_hosting_ispmgr is ordered for domain qqq.ru',
        'payment' => '100',
        'pay_notes' => 'Amount successfully charged',
        'bill_id' => '1234',
	'service_id' => '987654'
     }
}

Возможные ошибки:

Error_code	Error_text	Описание
NEEDS_CONFIRMATION	Service already ordered and need confirmation.	Услуга уже заказана и требует подтверждения.
WAITING	Service already ordered but not processed.	Услуга уже заказана но еще не отработана.

Cм. cтандартные коды ошибок

9.4. Функция: service/delete

Назначение:

Удаляет услугу

Доступность:

клиенты

Поля запроса:

стандартные параметры идентификации услуги а также

Поле	Значения	Описание
servtype	"srv_hosting_ispmgr" "srv_hosting_cpanel" "srv_hosting_plesk" "srv_hosting_dctadm" "srv_addip" "srv_antispam" "srv_sitebuilder_plsk" "srv_vps" "srv_license_isp" "srv_disk_space" "srv_dedicated" "srv_kvm"	Тип услуги, которую удаляем

Поддержка обработки списка услуг:

нет

Поля ответа:

Особых нет

Пример запроса:

https://api.reg.ru/api/regru2/service/delete?username=test&password=test&domain_name=test.ru&servtype=srv_hosting_ispmgr

Пример успешного ответа:

{
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

9.5. Функция: service/get_info

Назначение:

получить информацию о услугах

Доступность:

клиенты

Поля запроса:

стандартные параметры идентификации услуги,
параметры идентификации списка услуг а также

Поле	Значения	Описание
show_folders	0 и 1	Дополнительно привести список папок, в которые входит услуга, по умолчанию — 0

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
services	Список хешей параметров услуг.
subtype	подтип услуги (для хостинга: идентификатор тарифного плана)
state	состояние услуги, допустимые варианты: «N» – услуга неактивна (домен не зарегистрирован / не перенесён); «A» – услуга активна; «S» – услуга приостановлена; «D» – услуга удалёна; «O» – домен перенесён к другому регистратору.
creation_date	дата активации услуги
expiration_date	дата истечения оплаченного периода услуги

Пример запроса:

https://api.reg.ru/api/regru2/service/get_info?username=test&password=test&input_format=json&input_data={"services":[{"domain_name":"test.ru"},{"service_id":"111111"}]}

Пример ответа:

{
   "answer" : {
      "services" : [
         {
            "future_periods" : "0",
            "expiration_date" : "2101-01-01",
            "service_id" : "12345",
            "state" : "A",
            "subtype" : "test",
            "creation_date" : "2001-01-01",
            "servtype" : "domain",
            "result" : "success"
         },
         {
            "future_periods" : "0",
            "expiration_date" : "2101-01-01",
            "service_id" : "111111",
            "state" : "A",
            "subtype" : "test",
            "creation_date" : "2001-01-01",
            "servtype" : "domain",
            "result" : "success"
         }
      ]
   },
   "result" : "success"
}

Возможные ошибки:

Cм. cтандартные коды ошибок

9.6. Функция: service/get_list

Назначение:

получить список активных услуг

Доступность:

клиенты

Поля запроса:

Поле

Описание

servtype

Вид услуги: domain — «Домен», srv_webfwd — «Web-форвардинг», srv_parking — «Парковка домена», srv_dns_both — «Поддержка DNS», srv_hosting_ispmgr — «ISPManager хостинг», srv_hosting_cpanel — «CPanel хостинг», srv_hosting_plesk — «Plesk хостинг», srv_antispam — «Расширенная защита от спама», srv_vps — «VPS сервер», srv_addip — «Дополнительный ip адрес», srv_license_isp — «ISPManager лицензия», srv_certificate — «Сертификат на домен», srv_voucher — «Свидетельство на домен». Если значение не указано, возвращаются услуги всех видов.

Поля ответа:

Поле	Описание
services	Список хешей параметров услуг.
service_id	числовой идентификатор услуги
dname	имя домена
subtype	подтип услуги (для хостинга: идентификатор тарифного плана)
state	состояние услуги, допустимые варианты: «N» – услуга неактивна (домен не зарегистрирован / не перенесён); «A» – услуга активна; «S» – услуга приостановлена;
creation_date	дата активации услуги
expiration_date	дата истечения оплаченного периода услуги

Пример запроса:

https://api.reg.ru/api/regru2/service/get_list?username=test&password=test&input_format=json&input_data={"servtype":"domain"}&output_content_type=plain

Пример ответа:

{
   "answer" : {
      "services" : [
         {
            "subtype" : "test",
            "dname" : "test.ru",
            "creation_date" : "2009-04-18",
            "uplink_service_id" : "0",
            "expiration_date" : "2011-04-18",
            "servtype" : "domain",
            "service_id" : "111",
            "state" : "A"
         },
         {
            "subtype" : "test",
            "dname" : "foo-test.ru",
            "creation_date" : "2009-04-29",
            "uplink_service_id" : "0",
            "expiration_date" : "2011-04-29",
            "servtype" : "srv_hosting_ispmgr",
            "service_id" : "222",
            "state" : "A"
         }
      ]
   },
   "result" : "success"
}

Возможные ошибки:

Cм. cтандартные коды ошибок

9.7. Функция: service/get_folders

Назначение:

получение списка папок в которые входит сервис

Доступность:

клиенты

Поля запроса:

стандартные параметры идентификации услуги

Поддержка обработки списка услуг:

нет

Поля ответа:

Поле	Описание
folders	список папок, может быть пустым
folder_id	идентификатор папки
folder_name	имя папки

Пример запроса:

https://api.reg.ru/api/regru2/service/get_folders?username=test&password=test&domain_name=test.ru

Пример успешного ответа:

{
{
    answer => {
        folders : [
            {
                folder_name => 'test_folder',
                folder_id   => 12345
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

9.8. Функция: service/get_details

Назначение:

Получения дополнительных данных по сервису, в т.ч. контактных данных для доменов

Доступность:

клиенты

Поля запроса:

стандартные параметры идентификации услуги,
параметры идентификации списка услуг, а также

Поле	Допустимые значения	Описание
separate_groups	0 и 1	При значении 1 делается разбивка выходных данных по группам, группы для каждого сервиса или доменной зоны свои, значение по умолчанию 0
show_contacts_only	0 и 1	При значении 1 возвращаются только контактные данные, что удобно при работе с доменами, для других сервисов не имеет смысла, значение по умолчанию 0

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
services	список доменов с параметрами dname, servtype, service_id, details и contacts, или error_code c кодом ошибки идентификации услуги
details	список всех дополнительных данных сервиса, в случае вызова функции с параметром separate_groups делается разбивка данных по группам.
contacts	список контактов конкретного домена, подробное описание для каждой доменной зоны см. в описании функции domain/create, возвращается только при вызове с параметром show_contacts_only
Дополнительные поля, возвращаемые для услуги хостинга
login	логин хостинг-аккаунта
passwd	пароль хостинг-аккаунта
server_ip	IP-адрес сервера, на котором обслуживается аккаунт
nss	список NS-серверов хостинга
Дополнительные поля, возвращаемые для услуги web-форвардинга
fwds	Список всех web-перенаправлений домена. Содержит поля fwdfrom(Переадресация с), fwdto(Переадресовывать на), webfwd_type(Способ переадресации), title(Заголовок окна, если webfwd_type = frames).
Дополнительные поля, возвращаемые для услуги парковки
title	Заголовок страницы. Просто элемент оформления шаблона.
content	HTML-код страницы.
counter_html_code	HTML-код счётчиков (опционально).
template_name	Идентификатор шаблона. Доступные идентификаторы: private_property «Частная собственность» under_construction «На сайте идут строительные работы» for_sale «Домен выставлен на продажу» for_rent «Домен сдается в аренду» for_you_gift «Для Вас подарок» happy_new_year «С Новым годом!» happy_birthday1 «С Днем рождения!» (вариант 1) happy_birthday2 «С Днем рождения!» (вариант 2) love_happiness «Любви и счастья!» empty Пустая страница raw_html Ваш HTML код (только для платной парковки, без стандарного рекламного блока)
html_title	HTML мета-тег «Title».
html_description	HTML мета-тег «Description».
html_keywords	HTML мета-тег «Keywords».
opt_user_contacts	Отобразить информационный блок с контактами Администратора домена.
opt_feedback_link	Отобразить информационный блок со ссылкой "Связь с Администратором домена" (ссылка на Whois по домену). Возможные значения: «1» — функция включена «0» — функция отключена
opt_domain_shop_link	Отобразить информационный блок со ссылкой на лот в Магазине доменов (при условии, что домен выставлен на продажу в Магазине доменов). Возможные значения: «1» — функция включена «0» — функция отключена
opt_whois_link	Отобразить информационный блок со ссылкой на историю Whois домена. Возможные значения: «1» — функция включена «0» — функция отключена
opt_se_link	Отобразить информационный блок со cсылками на домен в поисковых системах. Возможные значения: «1» — функция включена «0» — функция отключена
opt_indexed_link	Отобразить информационный блок cо ссылками на проиндексированные страницы различными поисковыми системами. Возможные значения: «1» — функция включена «0» — функция отключена
opt_blogs_link	Отобразить информационный блок cо ссылками на проиндексированные страницы различными поисковыми системами. Возможные значения: «1» — функция включена «0» — функция отключена

Примеры запросов:

Запрос с несколькими доменами в списке

https://api.reg.ru/api/regru2/service/get_details?input_format=json&input_data={"username":"test","password":"test","domains":[{"dname":"vschizh.ru"},{"dname":"vschizh.org"}]}

Запрос с параметром separate_groups

https://api.reg.ru/api/regru2/service/get_details?username=test&password=test&domain_name=vschizh.ru&separate_groups=1

Запрос с параметром show_contacts_only

https://api.reg.ru/api/regru2/service/get_details?username=test&password=test&domain_name=vschizh.ru&show_contacts_only=1

Примеры успешного ответа:

Ответ на запрос с несколькими доменами в списке

{
    'answer' => {
        'services' => [
            {
                'dname'      => 'vschizh.ru',
                'servtype'   => 'domain',
                'service_id' => '12345'
                'details'    => {
                    'country'   	  => 'RU',
                    'e_mail'     	  => 'test@test.ru',
                    'person_r'   	  => 'Рюрик Святослав Владимирович',
                    'id_state'   	  => 'VERIFIED',
                    'phone'      	  => '+7 495 1234567',
                    'birth_date' 	  => '01.01.1101',
                    'descr'      	  => 'test contacts',
                    'person'     	  => 'Svyatoslav V Ryurik',
                    'p_addr'     	  => '12345, г. Вщиж, ул. Княжеска, д.1, Рюрику Святославу Владимировичу, князю Вщижскому',
                    'passport'   	  => '22 44 668800, выдан по месту правления 01.09.1164'
		    'private_person_flag' => '1',
		    'total_pp_flag'	  => '1'
                },
                'result'     => 'success'
            },
            {
                'dname'      => 'vschizh.org',
                'servtype'   => 'domain',
                'service_id' => '12346'
                'details'    => {
                    'o_email'        => 'test@test.ru',
                    'o_addr'         => 'Vschizh Goverment, house 1, Knyazheska str',
                    'o_phone'        => '+7.4951234567',
                    'o_state'        => 'VSZ',
                    'o_postcode'     => '12345',
                    'o_city'         => 'Vschizh',
                    'o_first_name'   => 'Svyatoslav',
                    'o_last_name'    => 'Ryurik',
                    'o_company'      => 'Vschizh City',
                    'o_country_code' => 'RU',
                    'o_fax'          => '+7.4951234567'
                },
                'result'     => 'success'
            }
        ]
    },
    'result' => 'success'
}

Ответ на запрос с параметром separate_groups

{
    'answer' => {
        'services' => [
            {
                'dname'      => 'vschizh.ru',
                'service_id' => '12345',
                'servtype'   => 'domain',
                'details'    => {
                    'ru_id' => {
                        'id_state'   => 'VERIFIED'
                    },
                    'ru_dd' => {
                        'descr'      => 'test user domain'
                    },
                    'ru_pp' => {
                        'country'    => 'RU',
                        'e_mail'     => 'test@test.ru',
                        'person_r'   => 'Рюрик Святослав Владимирович',
                        'phone'      => '+7 495 1234567',
                        'birth_date' => '01.01.1101',
                        'person'     => 'Svyatoslav V Ryurik',
                        'p_addr'     => '12345, г. Вщиж, ул. Княжеска, д.1, Рюрику Святославу Владимировичу, князю Вщижскому',
                        'passport'   => '22 44 668800, выдан по месту правления 01.09.1164'
                    }
                },
                'result'     => 'success'
            }
        ]
    },
    'result' => 'success'
}

Ответ на запрос с параметром show_contacts_only

{
    'answer' => {
        'services' => [
            {
                'contacts' => {
                    'country'    => 'RU',
                    'e_mail'     => 'test@test.ru',
                    'person_r'   => 'Рюрик Святослав Владимирович',
                    'phone'      => '+7 495 1234567',
                    'birth_date' => '01.01.1101',
                    'descr'      => 'test user domain'
                    'person'     => 'Svyatoslav V Ryurik',
                    'p_addr'     => '12345, г. Вщиж, ул. Княжеска, д.1, Рюрику Святославу Владимировичу, князю Вщижскому',
                    'passport'   => '22 44 668800, выдан по месту правления 01.09.1164'
                },
                'dname'      => 'vschizh.ru',
                'service_id' => '12345',
                'servtype'   => 'domain',
                'result'     => 'success'
            }
        ]
    },
    'result' => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

9.9. Функция: service/service_get_details

Назначение:

Получение общей информации по заказанной услуге и дополнительных параметров для хостинга и web-форвардинга.
Для большинства сервисов вместо этой функции лучше использовать service/get_info.
Depricated

Доступность:

клиенты

Поля запроса:

стандартные параметры идентификации услуг

Поддержка обработки списка услуг:

нет

Поля ответа:

Поле	Описание
Поля, возвращаемые для любой услуги
subtype	подтип услуги (для хостинга: идентификатор тарифного плана)
state	состояние услуги, допустимые варианты: «N» – услуга неактивна (домен не зарегистрирован / не перенесён); «A» – услуга активна; «S» – услуга приостановлена; «D» – услуга удалёна; «O» – домен перенесён к другому регистратору.
creation_date	дата активации услуги
expiration_date	дата истечения оплаченного периода услуги
Поля, возвращаемые для услуги хостинга
login	логин хостинг-аккаунта
passwd	пароль хостинг-аккаунта
server_ip	IP-адрес сервера, на котором обслуживается аккаунт
nss	список NS-серверов хостинга
Поля, возвращаемые для услуги web-форвардинга
fwds	Список всех web-перенаправлений домена. Содержит поля fwdfrom(Переадресация с), fwdto(Переадресовывать на), webfwd_type(Способ переадресации), title(Заголовок окна, если webfwd_type = frames).

Примеры запросов:

• идентификация по service_id
  https://api.reg.ru/api/regru2/service/service_get_details?username=test&password=test&service_id=123456
• идентификация по domain_name и servtype
  https://api.reg.ru/api/regru2/service/service_get_details?username=test&password=test&servtype=srv_hosting_ispmgr&domain_name=testtest.name
• идентификация только по имени домена
  https://api.reg.ru/api/regru2/service/service_get_details?username=test&password=test&domain_name=testtest.name

Пример успешного ответа:

• для хостинга

  
  {
      answer : {
          passwd : "test",
          creation_date : "2008-12-31",
          expiration_date : "2009-01-01",
          servtype : "srv_hosting_ispmgr",
          server_ip : "89.253.240.98",
          login : "test",
          state : "A",
          subtype : "Host-1"
      },
      result : "success"
  }
  

• для web-форвардинга

  
  {
     result : "success",
     answer : {
        fwds : [
           {
              fwdfrom : "/",
              fwdto : "http://mysite1.ru",
              webfwd_type : "frames",
  	    title : "Мой сайт"
           },
           {
              fwdfrom : "/news/",
              fwdto : "http://mysyte2.ru",
              webfwd_type : "redirect"
           }
        ],
        creation_date : "2008-12-31",
        expiration_date : "2009-01-01",
        servtype : "srv_webfwd",
        state : "A",
        subtype : ""
     }
  }
  

Возможные ошибки:

Cм. cтандартные коды ошибок

9.10. Функция: service/get_dedicated_server_list

Назначение:

Получение списка выделенных серверов доступных для заказа.

Доступность:

клиенты

Поля запроса:

стандартные параметры идентификации услуг

Поддержка обработки списка услуг:

нет

Поля ответа:

Поле	Описание
server_id	Уникальный идентификатор сервера
cpu_content	Описание модели процессора
cpu_count	Количество процессоров
cpu_core	Количество ядер на процессор
ram_content	Тип оперативной памяти
ram_count	Количество плат памяти
ram_size	Объем памяти одной платы
hdd_content	Тип интерфейса жесткого диска
hdd_count	Количество жестких дисков
hdd_size	Объем одного жесткого диска
month_traf	Количество предоплаченного трафика, тб в месяц
price_retail	Стоимость аренды сервера в месяц

Примеры запросов:

https://api.reg.ru/api/regru2/service/get_dedicated_server_list?username=test&password=test&output_content_type=plain

Пример успешного ответа:

{
    answer : {
        server_list : [
            {
                server_id : "171",
                cpu_content : "Intel Pentium 4 2.8Ghz",
                cpu_count : "1",
                cpu_core : "2",
                hdd_content : "IDE",
                hdd_count : "2",
                hdd_size : "120Gb",
                ram_content : "RAM"
                ram_count : "2",
                ram_size : "512Mb",
                month_traf : "1000",
                price_retail : "3080",
            }
        ]
    },
    result : "success"
}

Возможные ошибки:

Cм. cтандартные коды ошибок

9.11. Функция: service/update (неполное описание)

Назначение:

настройка услуги.

Доступность:

клиенты

Поля запроса:

Параметр	Описание
Общие
dname	Имя домена настраиваемого сервиса.
servtype	Вид заказываемой услуги: srv_webfwd — «Web-форвардинг», srv_ssl_certificate — «SSL-Сертификат», srv_vps — «VPS», srv_hosting_cpanel — «Cpanel хостинг», srv_antispam — «Расширенная защита от спама», srv_dedicated — «Выделенный сервер».
Web-форвардинг (srv_webfwd)
fwd_action	Действие, доступны: addfwd(добавить перенаправление), rmfwd(удалить перенаправление), rmall(удалить все перенаправления). DEPRECATED. Используйте параметр subtask.
subtask	Действие, доступны: addfwd(добавить перенаправление), rmfwd(удалить перенаправление), rmall(удалить все перенаправления).
fwdfrom	«Переадресация с», укажите относительный адрес (без имени домена), с которого требуется осуществлять перенаправление(если не указано, то «/»).
fwdto	«Переадресовывать на», укажите URL, на который следует перенаправлять посетителей.
webfwd_type	Способ переадресации, может принимать значения: redirect(перенаправление запроса), frames(маскировку адреса во фрейме). Если не указано, то redirect.
title	Заголовок окна, имеет смысл только в случае использования маскировки адреса во фрейме. Указанный заголовок будет заголовком страницы (будет отображаться в качестве заголовка окна браузера).
Парковка (srv_parking)
title	Заголовок страницы. Просто элемент оформления шаблона.
content	HTML-код страницы.
counter_html_code	HTML-код счётчиков (опционально).
template_name	Идентификатор шаблона. Доступные идентификаторы: private_property «Частная собственность» under_construction «На сайте идут строительные работы» for_sale «Домен выставлен на продажу» for_rent «Домен сдается в аренду» for_you_gift «Для Вас подарок» happy_new_year «С Новым годом!» happy_birthday1 «С Днем рождения!» (вариант 1) happy_birthday2 «С Днем рождения!» (вариант 2) love_happiness «Любви и счастья!» empty Пустая страница raw_html Ваш HTML код (только для платной парковки, без стандарного рекламного блока)
html_title	HTML мета-тег «Title».
html_description	HTML мета-тег «Description».
html_keywords	HTML мета-тег «Keywords».
opt_user_contacts	Отобразить информационный блок с контактами Администратора домена.
opt_feedback_link	Отобразить информационный блок со ссылкой "Связь с Администратором домена" (ссылка на Whois по домену). Возможные значения: «1» — функция включена «0» — функция отключена
opt_domain_shop_link	Отобразить информационный блок со ссылкой на лот в Магазине доменов (при условии, что домен выставлен на продажу в Магазине доменов). Возможные значения: «1» — функция включена «0» — функция отключена
opt_whois_link	Отобразить информационный блок со ссылкой на историю Whois домена. Возможные значения: «1» — функция включена «0» — функция отключена
opt_se_link	Отобразить информационный блок со cсылками на домен в поисковых системах. Возможные значения: «1» — функция включена «0» — функция отключена
opt_indexed_link	Отобразить информационный блок cо ссылками на проиндексированные страницы различными поисковыми системами. Возможные значения: «1» — функция включена «0» — функция отключена
opt_blogs_link	Отобразить информационный блок cо ссылками на проиндексированные страницы различными поисковыми системами. Возможные значения: «1» — функция включена «0» — функция отключена
SSL сертификат (srv_ssl_certificate)
обязательные: org_org_name, org_address, org_city, org_state, org_postal_code, org_country, org_phone необязательные: org_first_name, org_last_name, org_fax	Название, имя, фамилия, адрес, город, штат(провинция), почтовый индекс, страна, телефон, факс организации. Используются для всех SSL сертификатов компаний Thawte, Comodo, VeriSign, а так-же для GeoTrust SSL сертификатов: True BusinessID, True BusinessID Wildcard, True BusinessID with EV.
обязательные: admin_first_name, admin_last_name, admin_title, admin_address, admin_city, admin_state, admin_postal_code, admin_country, admin_phone, admin_email, необязательные: admin_fax, admin_org_name	Имя, фамилия, должность, адрес, город, штат, почтовый индекс, страна, телефон, e-mail, факс, название организации адрес администратора. Используются для всех SSL сертификатов компаний Thawte, GeoTrust, Trustwave и VeriSign, а так-же для Comodo EV SSL сертификата.
обязательные: billing_first_name, billing_last_name, billing_title, billing_address, billing_city, billing_state, billing_postal_code, billing_country, billing_phone, billing_email, необязательные: billing_fax, billing_org_name	Имя, фамилия, должность, адрес, город, штат, почтовый индекс, страна, телефон, e-mail, факс, название организации адрес финансового менеджера. Используются для всех SSL сертификатов компаний Thawte, GeoTrust и VeriSign.
обязательные: tech_first_name, tech_last_name, tech_title, tech_address, tech_city, tech_state, tech_postal_code, tech_country, tech_phone, tech_email, необязательные: tech_fax, tech_org_name	Имя, фамилия, должность, адрес, город, штат, почтовый индекс, страна, телефон, e-mail, факс, название организации адрес технического специалиста. Используются для всех SSL сертификатов компаний Thawte, GeoTrust и VeriSign.
обязательные: signer_first_name, signer_last_name, signer_title, signer_address, signer_city, signer_state, signer_postal_code, signer_country, signer_phone, signer_email, необязательные: signer_fax, signer_org_name	Имя, фамилия, должность, адрес, город, штат, почтовый индекс, страна, телефон, e-mail, факс, название организации адрес ответственного за подписку SSL сертиификата. Используются для Comodo EV SSL сертификата.
approver_email	E-mail адрес для подтверждения сертификата.
server_type	Программное обеспечение. Возможные значения: Для Comodo SSL сертификатов: apachessl, citrix, domino, ensim, hsphere, iis4, iis6, iis7, iplanet, javawebserver, netscape, ibmhttp, novell, oracle, other, plesk, redhat, sap, tomcat, webstar, whmcpanel Для Thawte, GeoTrust и VeriSign SSL сертификатов: apache2 apacheopenssl apacheraven apachessl apachessleay c2net cobaltseries cobaltraq3 cobaltraq2 cpanel domino dominogo4626 dominogo4625 ensim hsphere iis iis4 iis5 iplanet ipswitch netscape ibmhttp other plesk tomcat weblogic website webstar webstar4 zeusv3 Для TrustWave SSL Сертификатов данный параметр не используется.
csrString	Закодированный CSR включая маркеры начала и окончания.
subtype	Вид сертификата. Возможные значения: Thawte: ssl123, sgcsuper_certs, sslwebserver, sslwebserver_wildcard, sslwebserver_ev Symantec: securesite, securesite_pro, securesite_ev, securesite_pro_ev GeoTrust: quickssl, quickssl_premium, truebizid, truebizid_wildcard, truebizid_ev TrustWave: trustwave_dv, trustwave_ev, trustwave_premiumssl, trustwave_premiumssl_wildcard Comodo: comodo_ev, comodo_instantssl, comodo_premiumssl, comodo_premiumssl_wildcard, comodo_ssl, comodo_wildcard
reissue	Ненулевое значение инициирует переиздание сертификата с новыми полями csrString, software, approver_email. Нулевое значение или отсутствие флага вызывает обновление полей, без переиздания сертификата. Такой режим используется для подготовки полей перед продлением сертификата.
VPS (srv_vps)
subtask	Действие, доступны: reboot(загрузить/перезагрузить VPS), stop(остановить VPS), change_password(сменить пароль на root), change_hostname(сменить доменное имя VPS), reinstall(переустановить VPS).
new_ostmpl	Шаблон ОС, используется при переустановке VPS (параметр subtask = reinstall). Доступны следующие шаблоны ОС: "centos-x86", "centos-x86_64", "debian-x86", "debian-x86_64", "fedora-x86", "fedora-x86_64", "suse-x86", "suse-x86_64", "ubuntu-x86", "ubuntu-x86_64", "centos-x86_bitrix", "centos-x86_64_bitrix", "centos-x86_webmin", "centos-x86_64_webmin", "debian-x86_webmin", "debian-x86_64_webmin", "ubuntu-x86_webmin", "ubuntu-x86_64_webmin".
new_hostname	Доменное имя VPS, используется совместно с параметром subtask = change_hostname.
reinstall_ispmgr	Флаг, определяющй переустанавливать ли ISP Manager, используется при переустановке VPS (параметр subtask = reinstall).
Cpanel хостинг (srv_hosting_cpanel)
subtask	Действие, доступны: change_pass(сменить пароль на хостинг).
Расширенная защита от спама (srv_antispam)
subtask	Действие, доступны: change_action(сменить параметр "action", определяющий действия выполняемые над почтой распознанной как спам), change_mx_list(сменить список mx серверов используемых для транспорта отфильтрованной почты).
spam_action	Действие над спамом. Определяет какие действия будут выполнены над почтой распознанной как спам. Возможны 2 варианта: "delete" ( Удалять найденный спам ), "mark" ( Отметить найденный спам email-заголовками X-Spam-* ). Необязательный параметр, значение по умолчанию: "delete". Актуально для subtask = change_action.
mx_list	Список mx серверов через запятую, используемых для транспорта отфильтрованной почты. Актуально для subtask = change_mx_list.
Выделенный сервер (srv_dedicated)
subtask	Действие, доступны: change_hostname(сменить обратную PTR запись для одного из ip-адресов сервера ).
revert_dns_ip	Один из ip-адресов сервера.
new_hostname	Новое доменное имя для указанного ip.

Примечание: Для сервиса SSL-сертификат

Поддержка обработки списка услуг:

нет

Поля ответа:

Поле	Описание
descr	Общее описание сделанного заказа.

Пример запроса:

https://api.reg.ru/api/regru2/service/update?username=test&password=test&dname=qqq.ru&servtype=srv_webfwd&fwd_action=addfwd&fwdfrom=/&fwdto=http://www.reg.ru&webfwd_type=redirect

Пример успешного ответа:

{
    'result' => 'success';
    'answer' => {
	'descr' => 'service srv_webfwd is updated for domain qqq.ru'
     }
}

Возможные ошибки:

Cм. cтандартные коды ошибок

9.12. Функция: service/renew

Назначение:

продление домена или услуги

Доступность:

клиенты

Поля запроса:

Поле	Описание
period	Период продления.
Параметры оплаты (необязательны)
point_of_sale pay_type ok_if_no_money	См. Общие параметры оплаты.
allow_create_bills	Флаг, указывающий, что в случае недостатка денег на счету, запрос будет завершен без ошибки — будет создана выписка пополнения через банк. DEPRECATED. Не использовать!

А также стандартные параметры идентификации услуги, параметры идентификации списка услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
period	Установленный период продления.
bill_id	Номер счёта заказа.
payment	Цена заказа.
currency	Валюта указанной цены.
status	Состояние заказа. Допустимые варианты: renew_success и only_bill_created для случаев успешного прохождения счёта и нехватки денег соответственно.

Примеры запросов:

Идентификация по service_id

https://api.reg.ru/api/regru2/service/renew?username=test&password=test&service_id=123456&period=2

Идентификация по servtype + domain_name

https://api.reg.ru/api/regru2/service/renew?username=test&password=test&servtype=srv_hosting_ispmgr&domain_name=regrupanel.ru&period=1

Примеры успешных ответов:

Ответ на "PLAIN"-запрос

{
    'answer' => {
        'period'   => '2',
        'payment'  => '100',
        'currency' => 'RUR',
        'status'   => 'renew_success',
        'dname'    => 'test12345.ru',
        'bill_id'  => '123456',
        'servtype' => 'domain'
    },
    'result' => 'success',
}

Ответ на список из 2х доменов в JSON формате

{
    'answer' => {
        'currency' => 'RUR',
        'payment'  => '200',
        'period'   => '2',
        'services' => [
            {
                'dname'      => 'test12345.ru',
                'service_id' => '12345',
                'servtype'   => 'domain',
                'result'     => 'success'
            },
            {
                'dname'      => 'test12346.ru',
                'service_id' => '12346',
                'servtype'   => 'domain',
                'result'     => 'success'
            }
        ],
        'bill_id'  => '123456',
        'status'   => 'renew_success',
    },
    'result' => 'success',
}

Ответ при передаче флага allow_create_bills (случай, когда не хватило денег и создан лишь счёт):

{
    'answer' => {
        'period'   => '1',
        'payment'  => '100',
        'currency' => 'RUR',
        'status'   => 'only_bill_created',
        'dname'    => 'test12345.ru',
        'bill_id'  => '123123',
        'servtype' => 'domain'
    },
    'result' => 'success',
}

Возможные ошибки:

Error_code	Error_text	Описание
INCORRECT_STATE	Operation allowed only for suspended or active services.	Операция возможна только для активной или приостановленной услуги.
PROLONG_ERROR	Prolong error: $error_detail.	Ошибка продления: <подробности_ошибки>.

Cм. cтандартные коды ошибок

9.13. Функция: service/get_bills

Назначение:

получить список счетов, связанных с указанными услугами

Доступность:

партнёры

Поля запроса:

стандартные параметры идентификации доменов и услуг

Поддержка обработки списка услуг:

да

Поля ответа:

Поле	Описание
services	список запрошенных сервисов
bills	список номеров счетов, относящихся к данному сервису

Пример запроса:

https://api.reg.ru/api/regru2/service/get_bills?username=test&password=test&dname=qqq.ru

Пример успешного ответа:

{
    answer => {
        services => [
            {
                dname      => 'qqq.ru',
                servtype   => 'domain',
                service_id => 12345,
                bills      => [
                    123456,
                    234567
                ]
            }
        ]
    },
    result => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

9.14. Функция: service/set_autorenew_flag

Назначение:

установить или снять флаг автопродления

Доступность:

клиенты

Поля запроса:

Поле	Описание
flag_value	Флаг для установки, допустимые значения 0 и 1, любое ненулевое значение считается равным 1

А так же стандартные параметры идентификации доменов и услуг

Поддержка обработки списка услуг:

нет

Поля ответа:

Стандартные поля ответов для успешного изменения и ошибок

Пример запроса:

https://api.reg.ru/api/regru2/service/set_autorenew_flag?username=test&password=test&dname=qqq.ru&flag_value=1

Пример успешного ответа:

{
    'result' => 'success'
}

Возможные ошибки:

Cм. cтандартные коды ошибок

9.15. Функция: service/suspend

Назначение:

приостановить действие услуги (для домена - снять с делегирования)

Доступность:

клиенты

Поля запроса:

стандартные параметры идентификации услуг

Поддержка обработки списка услуг:

нет

Поля ответа:

нет

Пример запроса:

https://api.reg.ru/api/regru2/service/set_autorenew_flag?username=test&password=test&dname=qqq.ru

Пример успешного ответа:

{
    'result' => 'success'
}

Возможные ошибки:

Error_code	Error_text	Описание
SERVICE_NOT_ACTIVE	Service not active	Услуга уже приостановлена

Cм. cтандартные коды ошибок

9.16. Функция: service/resume

Назначение:

возобновить действие услуги (для домена - делегировать)

Доступность:

клиенты

Поля запроса:

стандартные параметры идентификации услуг

Поддержка обработки списка услуг:

нет

Поля ответа:

нет

Пример запроса:

https://api.reg.ru/api/regru2/service/resume?username=test&password=test&dname=qqq.ru

Пример успешного ответа:

{
    'result' => 'success'
}

Возможные ошибки:

Error_code	Error_text	Описание
SERVICE_NOT_SUSPENDED	Service not suspended	Услуга не приостановлена
SERVICE_EXPIRED	Service expired	Срок действия услуги истек

Cм. cтандартные коды ошибок.

9.17. Функция: service/get_depreciated_period

Назначение:

расчитать число периодов до даты истечения срока действия услуги

Доступность:

клиенты

Поля запроса:

Cтандартные параметры идентификации доменов и услуг

Поддержка обработки списка услуг:

нет

Поля ответа:

Поле	Описание
depreciated_period	Дробное число периодов, оставшихся до даты истечения срока действия услуги

Пример запроса:

https://api.reg.ru/api/regru2/service/get_depreciated_period?username=test&password=test&servtype=srv_hosting_ispmgr&dname=qqq.ru

Пример успешного ответа:

{
   "answer" : {
      "depreciated_period" : "1"
   },
   "result" : "success"
}

Возможные ошибки:

Cм. cтандартные коды ошибок

9.18. Функция: service/upgrade

Назначение:

произвести повышение подтипа (тарифа) услуги. Используется только для изменения тарифа виртуального хостинга ("srv_hosting_ispmgr") и VPS-серверов ("srv_vps").

Доступность:

клиенты

Поля запроса:

Поле	Описание
subtype	Новый подтип (тариф) услуги. Для услуг хостинга ("srv_hosting_ispmgr") допустимыми значениями являются: "Host-0-0910", "Host-1-1209", "Host-2-1209", "Host-3-1209", "Host-CMS-1209", "Host-Lite-0910" Для услуг VPS ("srv_vps") допустимыми значениями являются: "VPS-2-1011", "VPS-3-1011", "VPS-4-1011".
period	Число периодов, на который заказывается новая услуга

А так же стандартные параметры идентификации доменов и услуг

Поддержка обработки списка услуг:

нет

Поля ответа:

Поле	Описание
withdrawed_amount	Количество денежных средств, списанных по операции
returned_amount	В том числе зачислено на лицевой счет
new_service_id	Идентификатор нового сервиса с новым подтипом (тарифом)

Пример запроса:

https://api.reg.ru/api/regru2/service/upgrade?username=test&password=test&subtype=Host-2-1209&period=2&servtype=srv_hosting_ispmgr&dname=qqq.ru

Пример успешного ответа:

{
   "answer" : {
      "returned_amount" : "100",
      "withdrawed_amount" : "100",
      "new_service_id" : "-1"
   },
   "result" : "success"
}

Возможные ошибки:

Error_code	Error_text	Описание
SERVICE_UPGRADE_NOT_ALLOWED	Service upgrade is not allowed	Услуга имеет недопустимый тип или невозможно сменить подтип услуги на заданный

А также cм. Стандартные коды ошибок

9.19. Функция: service/partcontrol_grant

Назначение:

предоставить право частичного управления услугой другому пользователю

Доступность:

клиенты

Поля запроса:

Поле	Описание
newlogin	Логин пользователя, которому нужно передать частичное управление

А так же стандартные параметры идентификации доменов и услуг

Поддержка обработки списка услуг:

нет

Поля ответа:

Поле	Описание
newlogin	Логин пользователя, которому передано частичное управление
service_id	идентификатор домена или услуги

Пример запроса:

https://api.reg.ru/api/regru2/service/partcontrol_grant?username=test&password=test&newlogin=test_user&service_id=1

Пример успешного ответа:

{
   "answer" : {
      "service_id" : "1",
      "newlogin" : "test_user"
   },
   "result" : "success"
}

Возможные ошибки:

Cм. cтандартные коды ошибок

9.20. Функция: service/partcontrol_revoke

Назначение:

отключить право частичного управления услугой

Доступность:

клиенты

Поля запроса:

См. стандартные параметры идентификации доменов и услуг

Поддержка обработки списка услуг:

нет

Поля ответа:

Поле	Описание
service_id	идентификатор домена или услуги

Пример запроса:

https://api.reg.ru/api/regru2/service/partcontrol_revoke?username=test&password=test&service_id=1

Пример успешного ответа:

{
   "answer" : {
      "service_id" : "1"
   },
   "result" : "success"
}

Возможные ошибки:

Cм. cтандартные коды ошибок

10. Функции для работы с папками (категория folder)

10.1. Функция: folder/nop

Назначение:

тестовая функция, можно использовать как средство для проверки существования папки

Доступность:

все

Поля запроса:

Поле	Описание
folder_name или folder_id	Идентифицирует папку, с которой будет совершено действие. (см. стандартные параметры идентификации папок)

Поддержка обработки списка услуг:

нет

Поля ответа:

стандартные ответы системы

Примеры запросов:

• инициализация с ID folder_id
  https://api.reg.ru/api/regru2/folder/nop?username=test&password=test&folder_id=123456&output_content_type=plain
• инициализация с именем folder_name
  https://api.reg.ru/api/regru2/folder/nop?username=test&password=test&folder_name=test_folder_name&output_content_type=plain

Пример успешного ответа:

{
    "answer" : {
        "name" : "test_folder_name",
        "id" : "-1"
    },
    "result" : "success"
}

Возможные ошибки:

Cм. cтандартные коды ошибок

10.2. Функция: folder/create

Назначение:

создание папки

Доступность:

все

Поля запроса:

Поле	Описание
folder_name	Задает название новой папки.

Поддержка обработки списка услуг:

нет

Поля ответа:

стандартные ответы системы

Примеры запросов:

• создание папки с именем test_folder_name
  https://api.reg.ru/api/regru2/folder/create?username=test&password=test&folder_name=test_folder_name

Пример успешного ответа:

    {
      "result" : "success"
    }

Возможные ошибки:

Cм. cтандартные коды ошибок

10.3. Функция: folder/remove

Назначение:

удаление папки

Доступность:

все

Поля запроса:

Поле	Описание
folder_name или folder_id	Идентифицирует папку, с которой будет совершено действие. (см. стандартные параметры идентификации папок)

Поддержка обработки списка услуг:

нет

Поля ответа:

стандартные ответы системы

Примеры запросов:

• удаление из папки с ID folder_id
  https://api.reg.ru/api/regru2/folder/remove?username=test&password=test&folder_id=123456&output_content_type=plain
• удаление из папки с именем folder_name
  https://api.reg.ru/api/regru2/folder/remove?username=test&password=test&folder_name=test_folder_name&output_content_type=plain

Пример успешного ответа:

    {
      "result" : "success"
    }

Возможные ошибки:

Cм. cтандартные коды ошибок

10.4. Функция: folder/rename

Назначение:

переименование папки.

Доступность:

все

Поля запроса:

Поле	Описание
folder_name или folder_id	Идентифицирует папку, с которой будет совершено действие. (см. стандартные параметры идентификации папок)
new_folder_name	Задает новое имя папки

Поля ответа:

стандартные ответы системы

Примеры запросов:

• переименование папки с ID folder_id
  https://api.reg.ru/api/regru2/folder/rename?username=test&password=test&folder_id=123456&new_folder_name=new_test_folder_name&output_content_type=plain
• переименование папки с именем folder_name
  https://api.reg.ru/api/regru2/folder/rename?username=test&password=test&folder_name=test_folder_name&new_folder_name=new_test_folder_name&output_content_type=plain

Поддержка обработки списка услуг:

нет

Пример успешного ответа:

    {
      "result" : "success"
    }

Возможные ошибки:

Cм. cтандартные коды ошибок

10.5. Функция: folder/get_services

Назначение:

получить список услуг в папке

Доступность:

все

Поля запроса:

стандартные параметры идентификации папок

Поддержка обработки списка услуг:

нет

Поля ответа:

стандартные ответы системы

Примеры запросов:

• выдать список услуг в папке test_folder_name
  https://api.reg.ru/api/regru2/folder/get_services?username=test&password=test&folder_name=test_folder_name
• выдать список услуг в папке с ID 12345
  https://api.reg.ru/api/regru2/folder/get_services?username=test&password=test&folder_id=12345

Пример успешного ответа:

    "answer" : {
	"folder_content" : [
	    {
		"domain_name" : "test1.ru",
		"service_id" : "1000",
		"servtype" : "domain"
	    },
	    {
		"domain_name" : "test2.ru",
		"service_id" : "1001",
		"servtype" : "domain"
	    }
	],
	"result" : "success"
    }
	  

Возможные ошибки:

Cм. cтандартные коды ошибок

10.6. Функция: folder/add_services

Назначение:

добавление услуг в папку

Доступность:

все

Поля запроса:

Поле	Описание
folder_name или folder_id	Задает название папки, куда будут добавлены услуги. (см. стандартные параметры идентификации папок)
services	Задает список услуг, с которыми будет произведено действие. (см. стандартные параметры идентификации папок)
return_folder_contents	Если значение этого поля уставновлено в "1", то в ответе системы будет присутствовать список услуг в папке, с которой совершено действие.

Поддержка обработки списка услуг:

да

Поля ответа:

стандартные ответы системы

Примеры запросов:

• добавление списка услуг (test1.ru, test2.ru) в папку test_folder_name
  https://api.reg.ru/api/regru2/folder/add_services?username=test&password=test&input_format=json&input_data={"folder_name":"test_folder_name","services":[{"domain_name":"test1.ru"},{"domain_name":"test2.ru"}]}
• добавление списка услуг (с ID=1000, ID=1001) в папку с ID 12345
  https://api.reg.ru/api/regru2/folder/add_services?username=test&password=test&input_format=json&input_data={"folder_id":"12345","services":[{"service_id":"1000"},{"service_id":"1001"}]}

Пример успешного ответа:

• Без переданного параметра return_folder_content

  
  {
      "answer" : {
  	"services" : [
  	    {
  		"dname" : "test1.ru",
  		"servtype" : "domain",
  		"service_id" : "1000",
  		"result" : "success"
  	    },
  	    {
  		"dname" : "test2.ru",
  		"servtype" : "domain",
  		"service_id" : "1000",
  		"result" : "success"
  	    }
  	]
      },
      "result" : "success"
  }
  

• С параметром return_folder_content=1

  
  {
      "answer" : {
          "services" : [
              {
                  "dname" : "test01.ru",
                  "service_id" : "123456",
                  "servtype" : "domain",
                  "result" : "success"
              },
              {
                  "dname" : "test11.ru",
                  "result" : "Domain test11.ru not found or not owned by You",
                  "error_params" : {
                     "domain_name" : "test11.ru"
                  },
                  "error_code" : "DOMAIN_NOT_FOUND"
              }
          ],
          "folder_content" : [
              {
                  "domain_name" : "test1.ru",
                  "service_id" : "1000"
              },
              {
                  "domain_name" : "test2.ru",
                  "service_id" : "1001"
              }
          ]
      },
      "result" : "success"
  }
  

Возможные ошибки:

Cм. cтандартные коды ошибок

10.7. Функция: folder/remove_services

Назначение:

удаление услуг из папки

Доступность:

все

Поля запроса:

Поле	Описание
folder_name или folder_id	Задает название папки, откуда будут удалены услуги. (см. стандартные параметры идентификации папок)
services	Задает список услуг, с которыми будет произведено действие. (см. стандартные параметры идентификации папок)
return_folder_contents	Если значение этого поля уставновлено в "1", то в ответе системы будет присутствовать список услуг в папке, с которой совершено действие.

Поддержка обработки списка услуг:

да

Поля ответа:

стандартные ответы системы

Примеры запросов:

• удаление списка услуг (test1.ru, test2.ru) из папки test_folder_name
  https://api.reg.ru/api/regru2/folder/remove_services?username=test&password=test&input_format=json&input_data={"folder_name":"test_folder_name","services":[{"domain_name":"test1.ru"},{"domain_name":"test2.ru"}]}
• удаление списка услуг (с ID=1000, ID=1001) из папки с ID 12345
  https://api.reg.ru/api/regru2/folder/remove_services?username=test&password=test&input_format=json&input_data={"folder_id":"12345","services":[{"service_id":"1000"},{"service_id":"1001"}]}

Пример успешного ответа:

• Без переданного параметра return_folder_content

  
  {
      "answer" : {
  	"services" : [
  	    {
  		"dname" : "test1.ru",
  		"servtype" : "domain",
  		"service_id" : "1000",
  		"result" : "success"
  	    },
  	    {
  		"dname" : "test2.ru",
  		"servtype" : "domain",
  		"service_id" : "1000",
  		"result" : "success"
  	    }
  	]
      },
      "result" : "success"
  }
  

• С параметром return_folder_content=1

  
  {
      "answer" : {
          "services" : [
              {
                  "dname" : "test01.ru",
                  "service_id" : "123456",
                  "servtype" : "domain",
                  "result" : "success"
              },
              {
                  "dname" : "test11.ru",
                  "result" : "Domain test11.ru not found or not owned by You",
                  "error_params" : {
                     "domain_name" : "test11.ru"
                  },
                  "error_code" : "DOMAIN_NOT_FOUND"
              }
          ],
          "folder_content" : [
              {
                  "domain_name" : "test1.ru",
                  "service_id" : "1000"
              },
              {
                  "domain_name" : "test2.ru",
                  "service_id" : "1001"
              }
          ]
      },
      "result" : "success"
  }
  

Возможные ошибки:

Cм. cтандартные коды ошибок

10.8. Функция: folder/replace_services

Назначение:

перезаписывание услуг в папке (в результате данной операции все услуги в указанной папке удаляются, а услуги, указанные в параметре domain_name или service_id, добавляются в папку)

Доступность:

все

Поля запроса:

Поле	Описание
folder_name или folder_id	Задает название папки, куда будут перезаписаны услуги. (см. стандартные параметры идентификации папок)
services	Задает список услуг, с которыми будет произведено действие. (см. стандартные параметры идентификации папок)
return_folder_contents	Если значение этого поля уставновлено в "1", то в ответе системы будет присутствовать список услуг в папке, с которой совершено действие.

Поддержка обработки списка услуг:

да

Поля ответа:

стандартные ответы системы

Примеры запросов:

• перезапись списка услуг (test1.ru, test2.ru) в папке test_folder_name
  https://api.reg.ru/api/regru2/folder/replace_services?username=test&password=test&input_format=json&input_data={"folder_name":"test_folder_name","services":[{"domain_name":"test1.ru"},{"domain_name":"test2.ru"}]}
• перезапись списка услуг (с ID=1000, ID=1001) в папке с ID 12345
  https://api.reg.ru/api/regru2/folder/replace_services?username=test&password=test&input_format=json&input_data={"folder_id":"12345","services":[{"service_id":"1000"},{"service_id":"1001"}]}

Пример успешного ответа:

• Без переданного параметра return_folder_content

  
  {
      "answer" : {
  	"services" : [
  	    {
  		"dname" : "test1.ru",
  		"servtype" : "domain",
  		"service_id" : "1000",
  		"result" : "success"
  	    },
  	    {
  		"dname" : "test2.ru",
  		"servtype" : "domain",
  		"service_id" : "1000",
  		"result" : "success"
  	    }
  	]
      },
      "result" : "success"
  }
  

• С параметром return_folder_content=1

  
  {
      "answer" : {
          "services" : [
              {
                  "dname" : "test01.ru",
                  "service_id" : "123456",
                  "servtype" : "domain",
                  "result" : "success"
              },
              {
                  "dname" : "test11.ru",
                  "result" : "Domain test11.ru not found or not owned by You",
                  "error_params" : {
                     "domain_name" : "test11.ru"
                  },
                  "error_code" : "DOMAIN_NOT_FOUND"
              }
          ],
          "folder_content" : [
              {
                  "domain_name" : "test1.ru",
                  "service_id" : "1000"
              },
              {
                  "domain_name" : "test2.ru",
                  "service_id" : "1001"
              }
          ]
      },
      "result" : "success"
  }
  

Возможные ошибки:

Cм. cтандартные коды ошибок

10.9. Функция: folder/move_services

Назначение:

перенос услуг из одной папки в другую

Доступность:

все

Поля запроса:

Поле	Описание
folder_name или folder_id	Задает название папки, откуда будут перенесены услуги. (см. стандартные параметры идентификации папок)
new_folder_name или new_folder_id	Задает название папки, куда будут перенесены услуги (см. стандартные параметры идентификации папок)
services	Задает список услуг, с которыми будет произведено действие. (см. стандартные параметры идентификации папок)
return_folder_contents	Если значение этого поля уставновлено в "1", то в ответе системы будет присутствовать список услуг в папке, с которой совершено действие.

Поддержка обработки списка услуг:

да

Поля ответа:

стандартные ответы системы

Примеры запросов:

• перенос списка услуг (test1.ru, test2.ru) из папки test_folder_name в папку new_test_folder_name
  https://api.reg.ru/api/regru2/folder/move_services?username=test&password=test&input_format=json&input_data={"folder_name":"test_folder_name","new_folder_name":"new_test_folder_name","services":[{"domain_name":"test1.ru"},{"domain_name":"test2.ru"}]}
• перенос списка услуг (с ID=1000, ID=1001) из папки c ID 12345 в папку с ID 1234567
  https://api.reg.ru/api/regru2/folder/move_services?username=test&password=test&input_format=json&input_data={"folder_id":"12345","new_folder_id":"1234567","services":[{"service_id":"1000"},{"service_id":"1001"}]}

Пример успешного ответа:

• Без переданного параметра return_folder_content

  
  {
      "answer" : {
  	"services" : [
  	    {
  		"dname" : "test1.ru",
  		"servtype" : "domain",
  		"service_id" : "1000",
  		"result" : "success"
  	    },
  	    {
  		"dname" : "test2.ru",
  		"servtype" : "domain",
  		"service_id" : "1000",
  		"result" : "success"
  	    }
  	]
      },
      "result" : "success"
  }
  

• С параметром return_folder_content=1

  
  {
      "answer" : {
          "services" : [
              {
                  "dname" : "test01.ru",
                  "service_id" : "123456",
                  "servtype" : "domain",
                  "result" : "success"
              },
              {
                  "dname" : "test11.ru",
                  "result" : "Domain test11.ru not found or not owned by You",
                  "error_params" : {
                     "domain_name" : "test11.ru"
                  },
                  "error_code" : "DOMAIN_NOT_FOUND"
              }
          ],
          "folder_content" : [
              {
                  "domain_name" : "test1.ru",
                  "service_id" : "1000"
              },
              {
                  "domain_name" : "test2.ru",
                  "service_id" : "1001"
              }
          ]
      },
      "result" : "success"
  }
  

Возможные ошибки:

Cм. cтандартные коды ошибок