Заказ доменов через API

Функция заказа доменных имен

Вызов API-функции регистрации доменов должен производиться от имени учетной записи уровня "Пользователь".

Для заказа доменного имени через API Clouden используется функция domain.order.api :

Основные параметры

Параметр	Значение
`domain`	Имя регистрируемого домена.
`project`	Идентификатор (код) провайдера.
`pricelist`	Идентификатор (код) тарифа. Необязательный параметр, по умолчанию используется первый подходящий тариф провайдера.
`period`	Период регистрации. Необязательный параметр, по умолчанию используется минимальный доступный период тарифного плана.
`action`	Тип действия: register — регистрация домена, transfer — трансфер домена. Необязательный параметр, по умолчанию используется register.
`ns(0-3)`	Четыре сервера имён домена в формате domain.com , либо domain.com/ip , либо domain.com/ip,ip,...,ip .
`ns_additional`	Дополнительные серверы имен. Указываются через пробел в формате domain.com , либо domain.com/ip , либо domain.com/ip,ip,...,ip . Необязательный параметр.
`auth_code`	Код для трансфера домена. Необязательный параметр. Может использоваться при трансфере домена.

Параметры для указания контактных данных

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

Использование существующего контакта

Для использования существующих контактов применяются указанные параметры:

Параметр	Значение
`customer`	Идентификатор (код) контакта для анкеты клиента. Указывается при использовании существующего контакта домена, если требуется регистратором доменов.
`customer_XXX`	Список дополнительных параметров контакта, если требуются зоной или регистратором и не были ранее указаны. XXX — внутреннее имя параметра. Может указываться несколько раз.
`owner`	Идентификатор (код) контакта владельца домена. Указывается при использовании существующего контакта, если требуется регистратором доменов.
`owner_XXX`	Список дополнительных параметров контакта, если требуются зоной или регистратором и не были ранее указаны. XXX — внутреннее имя параметра. Может указываться несколько раз.
`admin`	Идентификатор (код) контакта администратора домена. Указывается при использовании существующего контакта, если требуется регистратором доменов.
`admin_XXX`	Список дополнительных параметров контакта, если требуются зоной или регистратором и не были ранее указаны. XXX — внутреннее имя параметра. Может указываться несколько раз.
`tech`	Идентификатор (код) контакта поддержки домена. Указывается при использовании существующего контакта, если требуется регистратором доменов.
`tech_XXX`	Список дополнительных параметров контакта, если требуются зоной или регистратором и не были ранее указаны. XXX — внутреннее имя параметра. Может указываться несколько раз.
`bill`	Идентификатор (код) финансового контакта домена. Указывается при использовании имеющегося контакта, если требуется регистратором доменов.
`bill_XXX`	Список дополнительных параметров контакта, если требуются зоной или регистратором и не были ранее указаны. XXX — внутреннее имя параметра. Может указываться несколько раз.

Создание нового контакта

Если какого-то типа контакта не существует в биллинговой платформе, но он требуется при регистрации, то новый контакт может быть создан непосредственно при заказе домена. Для этого передаются параметры:

Параметр Значение

contacttype_name Название анкеты для типа contacttype, где contacttype — это customer, admin, owner, tech или bill.

Параметр	Значение
`contacttype_name`	Название анкеты для типа contacttype, где contacttype — это customer, admin, owner, tech или bill.
`contacttype_type`	Тип анкеты: 1 — физ. лицо; 2 — компания; 3 — индивидуальный предприниматель.
`contacttype_XXX`	Список дополнительных параметров контакта, если требуются зоной или регистратором и не были ранее указаны. XXX — внутреннее имя параметра. Может указываться несколько раз.

contacttype_type

Тип анкеты:

1 — физ. лицо;
2 — компания;
3 — индивидуальный предприниматель.

contacttype_XXX Список дополнительных параметров контакта, если требуются зоной или регистратором и не были ранее указаны. XXX — внутреннее имя параметра. Может указываться несколько раз.

Стандартные параметры любой анкеты представлены следующим списком (подставляются вместо ХХХ):

Параметр	Значение
`company_locale`	Название организации на языке клиента. Для контакта с типом "Компания".
`company`	Название организации латиницей. Для контакта с типом "Компания".
`inn`	ИНН организации. Для контакта с типом "Компания".
`kpp`	КПП организации. Для контакта с типом "Компания".
`ogrn`	ОГРН организации. Для контакта с типом "Компания".
`firstname_locale`	Имя контактного лица на языке клиента.
`middlename_locale`	Отчество контактного лица на языке клиента.
`lastname_locale`	Фамилия контактного лица на языке клиента.
`firstname`	Имя контактного лица латиницей.
`middlename`	Отчество контактного лица латиницей.
`lastname`	Фамилия контактного лица латиницей.
`email`	Email адрес организации или контактного лица.
`phone`	Телефон организации или контактного лица.
`mobile`	Номер мобильного телефона контактного лица.
`fax`	Номер факса организации.
`passport`	Номер паспорта контактного лица. Указывается для физ лиц и индивидуальных предпринимателей.
`passport_org`	Организация выдавшая паспорт контактного лица. Указывается при указании номера документа.
`passport_date`	Дата выдачи паспорта контактного лица. Указывается при указании номера документа.
`birthdate`	Дата рождения контактного лица. Указывается для физ лиц и индивидуальных предпринимателей.
`private`	on — скрывать данные контакта в WHOIS при наличии такой возможности, off — не скрывать данные.
`location_country`	Код по справочнику биллинга страны регистрации контакта.
`location_state`	Регион регистрации контакта.
`location_postcode`	Индекс места регистрации контакта.
`location_city`	Город или другой населенный пункт регистрации контакта.
`location_address`	Адрес (улица, дом, квартира либо офис) регистрации контактного лица.
`postal_country`	Код по справочнику биллинга страны почтового адреса контакта.
`postal_state`	Регион почтового адреса контакта.
`postal_postcode`	Индекс почтового адреса контакта.
`postal_city`	Город или другой населенный пункт почтового адреса контакта.
`postal_address`	Почтовый адрес (улица, дом, квартира либо офис) контакта.
`postal_addressee`	Имя получателя почты.

Существует возможность предварительно создать контактные данные домена через API. Для этого используется функция service_profile.edit, которой передаются параметры:

Параметр Значение

name Название анкеты.

profiletype Тип анкеты: 1 — физ. лицо, 2 — компания, 3 — индивидуальный предприниматель.

Параметр	Значение
`name`	Название анкеты.
`profiletype`	Тип анкеты: 1 — физ. лицо, 2 — компания, 3 — индивидуальный предприниматель.
`sok`	Тип анкеты: 1 — физ. лицо; 2 — компания; 3 — индивидуальный предприниматель.

sok

Тип анкеты:

1 — физ. лицо;
2 — компания;
3 — индивидуальный предприниматель.

А также параметры создания контакта. При этом префикс contacttype указывать не нужно.

Чтобы создать анкету юридического лица с указанием ИНН, КПП и ОГРН, в запросе необходимо передать параметры &hide_inn=&hide_kpp=&hide_ogrn=.

Дополнительные функции

Функция domain.check проверяет наличие тарифов для регистрации домена и выводит стоимость периодов. Функция вызывается со следующими параметрами:

Параметр	Значение
`project`	Код провайдера.
`domain`	Имя домена.
`whois`	Проверить доступность домена для регистрации. Значение `on` включает проверку способом, который указан в настройках: `whois` или `rdap`. Необязательный параметр.

Функция domain.pricelist.param возвращает параметры регистрации доменов определённого тарифного плана. Параметры функции:

Параметр	Значение
`pricelist`	Код тарифного плана.

Примеры вызова функций

Регистрация доменного имени с использованием существующих контактных данных:

https://domain.com:1500/billmgr?authinfo=username  :userpassw&func=domain.order.api&domain=example.com&customer=1&owner=1&admin=1&tech=1&ns0=ns0.example.com/1.1.1.1&ns1=ns1.example.com/2.2.2.2

Регистрация домена с указанием дополнительных параметров контакта. Чтобы зарегистрировать домен в зоне PRO, укажите профессию:

https://domain.com:1500/billmgr?authinfo=username  :userpassw&func=domain.order.api&domain=example.pro&customer=1&owner=1&admin=1&tech=1&ns0=ns0.example.com/1.1.1.1&ns1=ns1.example.com/2.2.2.2&owner_profession=Web%20designer

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

https://domain.com:1500/billmgr?authinfo=username  :userpassw&func=domain.order.api&domain=example.com&action=register&project=1&customer_birthdate=1980-06-19&
 customer_email=example@email.ru&customer_firstname=Ivan&customer_firstname_locale=Иван&customer_lastname=Ivanov&customer_lastname_locale=Иванов&customer_location_address=Советская,25-12&
 customer_location_city=Москва&customer_location_country=182&customer_location_postcode=101001&customer_location_state=Москва&customer_passport=2500 000000&customer_passport_date=2015-06-01&
 customer_passport_org=УФМС по России&customer_phone=+7 123 1234567&customer_postal_address=Советская, 25-12&customer_postal_addressee=Иванов И.&customer_postal_city=Москва&
 customer_postal_country=182&customer_postal_postcode=101001&customer_postal_state=Москва&customer_private=on&ns0=ns1.example.com&ns1=ns2.example.com&customer_type=1&customer_name=newcontact

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

https://domain.com:1500/billmgr?authinfo=username  :userpassw&func=service_profile.edit&project=1&birthdate=1980-06-19&email=example@email.ru&firstname=Ivan&firstname_locale=Иван&lastname=Ivanov&lastname_locale=Иванов&location_address=Советская,25-12&location_city=Москва&location_country=182&location_postcode=101001&location_state=Москва&passport=2500 000000&passport_date=2015-06-01& passport_org=УФМС по России&phone=+7 123 1234567&postal_address=Советская,25-12&postal_addressee=Иванов И.&postal_city=Москва&postal_country=182&postal_postcode=101001&postal_state=Москва&private=on&ns0=ns1.example.com&ns1=ns2.example.com&profiletype=1&name=newcontact&sok=ok