Domain order via API

Domain registration API function

The domain registration API function must be called from a User-level account.

To register a domain name via the BILLmanager API, use the domain.order.api function.

Basic parameters

ParameterValue
domainDomain name to register.
projectProvider identifier (code).
pricelistTariff identifier (code). Optional; by default, the first suitable provider tariff is used.
periodRegistration period. Optional; by default, the minimum available period from the tariff plan is used.
actionAction type: register — domain registration, transfer — domain transfer. Optional; defaults to register.
ns(0-3)Four domain name servers in the format domain.com, or domain.com/ip, or domain.com/ip,ip,...,ip.
ns_additionalAdditional name servers. Specified space-separated in the format domain.com, or domain.com/ip, or domain.com/ip,ip,...,ip. Optional parameter.
auth_codeDomain transfer code. Optional. May be used during domain transfer.

Contact data parameters

A domain can be registered using existing contact data in BILLmanager or by creating new contact data during registration.

Using an existing contact

To use existing contacts, specify the following parameters:

ParameterValue
customerContact identifier (code) for the client profile. Specify when using an existing domain contact if required by the registrar.
customer_XXXList of additional contact parameters if required by the zone or registrar and not previously specified. XXX — internal parameter name. Can be specified multiple times.
ownerDomain owner contact identifier (code). Specify when using an existing contact if required by the registrar.
owner_XXXList of additional contact parameters if required by the zone or registrar and not previously specified. XXX — internal parameter name. Can be specified multiple times.
adminDomain administrator contact identifier (code). Specify when using an existing contact if required by the registrar.
admin_XXXList of additional contact parameters if required by the zone or registrar and not previously specified. XXX — internal parameter name. Can be specified multiple times.
techDomain technical support contact identifier (code). Specify when using an existing contact if required by the registrar.
tech_XXXList of additional contact parameters if required by the zone or registrar and not previously specified. XXX — internal parameter name. Can be specified multiple times.
billDomain billing contact identifier (code). Specify when using an existing contact if required by the registrar.
bill_XXXList of additional contact parameters if required by the zone or registrar and not previously specified. XXX — internal parameter name. Can be specified multiple times.

Creating a new contact

If a required contact type does not exist in the billing platform but is needed for registration, a new contact can be created directly during domain ordering. Use the following parameters:

ParameterValue
contacttype_nameProfile name for contact type contacttype, where contacttype is one of: customer, admin, owner, tech, or bill.
contacttype_type

Profile type:

  • 1 — individual;
  • 2 — company;
  • 3 — self-employed.
contacttype_XXXList of additional contact parameters if required by the zone or registrar and not previously specified. XXX — internal parameter name. Can be specified multiple times.

Standard parameters for any profile are listed below (substitute for XXX):

ParameterValue
company_localeOrganization name in the client's language. For "Company" contact type.
companyOrganization name in Latin characters. For "Company" contact type.
innOrganization tax ID (INN). For "Company" contact type.
kppOrganization tax registration reason code (KPP). For "Company" contact type.
ogrnOrganization state registration number (OGRN). For "Company" contact type.
firstname_localeContact person's first name in the client's language.
middlename_localeContact person's patronymic in the client's language.
lastname_localeContact person's last name in the client's language.
firstnameContact person's first name in Latin characters.
middlenameContact person's patronymic in Latin characters.
lastnameContact person's last name in Latin characters.
emailOrganization or contact person's email address.
phoneOrganization or contact person's phone number.
mobileContact person's mobile phone number.
faxOrganization fax number.
passportContact person's passport number. Required for individuals and self-employed persons.
passport_orgIssuing authority of the contact person's passport. Required when specifying passport number.
passport_datePassport issue date of the contact person. Required when specifying passport number.
birthdateContact person's date of birth. Required for individuals and self-employed persons.
privateon — hide contact data in WHOIS if supported, off — do not hide data.
location_countryBilling system country code for the contact's registration address.
location_stateContact's registration region.
location_postcodeContact's registration postal code.
location_cityContact's registration city or other populated place.
location_addressContact's registration street address (street, building, apartment, or office).
postal_countryBilling system country code for the contact's mailing address.
postal_stateContact's mailing region.
postal_postcodeContact's mailing postal code.
postal_cityContact's mailing city or other populated place.
postal_addressContact's mailing address (street, building, apartment, or office).
postal_addresseeMail recipient's name.

You can pre-create domain contact data via the API using the service_profile.edit function with the following parameters:

ParameterValue
nameProfile name.
profiletypeProfile type: 1 — individual, 2 — company, 3 — self-employed.
sok

Confirmation flag. Value must be non-empty (typically ok).

Also include the contact creation parameters. The contacttype prefix is not required in this case.

To create a legal entity profile with INN, KPP, and OGRN, include the parameters &hide_inn=&hide_kpp=&hide_ogrn= in the request.

Additional functions

The domain.check function checks tariff availability for domain registration and returns period pricing. Call it with the following parameters:

ParameterValue
projectProvider code.
domainDomain name.
whois

Check domain availability for registration. Value on enables checking via the method specified in settings: whois or rdap. Optional parameter.

The domain.pricelist.param function returns registration parameters for a specific tariff plan. Function parameters:

ParameterValue
pricelistTariff plan code.

Function call examples

Domain registration using existing contact data:

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

Domain registration with additional contact parameters. To register a domain in the .PRO zone, specify profession:

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

Domain registration with simultaneous creation of contact data:

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

Example of pre-creating a domain contact:

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