getList
Description:
Method returns list of domains on user account.


Call example:


https://api.beget.de/api/domain/getList?login=userlogin&
passwd=password&output_format=json



Response example:


[
   {
      "id":"132456",                    // domain ID    
  
      "fqdn":"mylogin.bget.de",         // full domain name      

      "date_add":"2011-10-24 15:01:40", // date and time of domain creation

      "auto_renew":"0",                 // "automatic domain renewal"  
                                        // option status

      "date_register":"2011-10-24",     // domain registration date
                                        // (if under BeGet administration)

      "date_expire":0,                  // expiration date of delegation 
                                        // (if under BeGet administration)

      "can_renew":"0",                  // renewal possibility status

      "registrar":null,                 // domain name registrar 
                                        // (if under BeGet administration)

      "registrar_status":null,          // domain status at registrar 
                                        // (if under BeGet administration). 
                                        // Can be: delegated, not_active, 
                                        // undelegated

      "register_order_status":null,     // status of domain registration order 
                                        // (if domain was added to  
                                        // its registration order). 
                                        // Can be: new, registred, delete

      "register_order_comment":null,    // comment on registration order 
                                        // (mostly comment 
                                        // on reasons of order annulment)

      "renew_order_status":"0",         // status of domain renewal order. 
                                        // Can be: pending, delete, 
                                        // canceled error, success

      "is_under_control":0              // Status shows if domain 
                                        // is under BeGet administration. 
                                        // Defines possibility of operations, such as: 
                                        // domain renewal,
                                        // ordering add. services from registrar, 
                                        // DNS server change
   }
]




getZoneList
Description:
Method returns zone list.


Call example:


https://api.beget.de/api/domain/getZoneList?login=userlogin&
passwd=password&output_format=json



Response example:


{
   "de":{
      "id":"1",               // zone ID
      "zone":"de",            // zone name
      "price":"120",          // price of domain registration in zone
      "price_renew":"120",    // price of domain renewal in zone
      "price_idn":null,       // price of IDN domain registration in zone
      "price_idn_renew":null, // price of IDN domain renewal in zone
      "is_idn":"0",           // does the zone support IDN domains
      "is_national":"1",      // is the zone national
      "min_period":"1",       // minimum domain registration period (in years)
      "max_period":"1"        // maximum domain registration period (in years)
   },
}




addVirtual
Description:
Method adds domain.


Additional parameters
hostname - domain name without zone (e.g. domain);
zone_id - zone id, type int;


Call example:


// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/domain/addVirtual?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"hostname":"domain","zone_id": 1}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/domain/addVirtual?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22hostname%22%3A%22domain%22%2C%22zone_id%22%3A+1%7D



Response example:


 12510



Returns ID of added domain.


delete
Description:
Method deletes domain. If the domain was linked to a website, it will be unlinked from it. All subdomains of this domain will be deleted.


Additional parameters
id - domain ID;


Call example:


// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/domain/delete?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"id":12510}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/domain/delete?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22id%22%3A12510%7D



Response example:


 true



Returns property of successful or unsuccessful execution.


getSubdomainList
Description:
Method returns subdomain list.


Call example:


https://api.beget.de/api/domain/getSubdomainList?login=userlogin&
passwd=password&output_format=json



Response example:


[
   {
      "id":"132456",                // subdomain ID
      "fqdn":"subodmain.domain.de", // full subdomain name
      "domain_id":"12345"           // parent domain ID
   },
   {
      "id":"123457",
      "fqdn":"user.forum.domain.com",
      "domain_id":"12347"
   }
]




addSubdomainVirtual
Description:
Method adds given subdomain.


Additional parameters
subdomain - subdomain name;
domain_id - parent domain ID;


Call example:


// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/domain/addSubdomainVirtual?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"subdomain": "subdomain","domain_id": 1000}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/domain/addSubdomainVirtual?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22subdomain%22%3A+%22subdomain
%22%2C%22domain_id%22%3A+1000%7D



Response example:


 12345



Returns ID of added subdomain.


deleteSubdomain
Description:
Method deletes given subdomain.


Additional parameters
id - subdomain id.


Call example:


// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/domain/deleteSubdomain?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"id": 1000}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/domain/deleteSubdomain?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22id%22%3A+1000%7D



Response example:


 true



Returns property of successful or unsuccessful execution.


checkDomainToRegister
Description:
Method returns information about registration possibility for given domain name.


Additional parameters
hostname - domain name without zone;
zone_id - zone ID, you can receive a zone list through the method getZoneList;
period - registration period (in years), type int.


Call example:


// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/domain/checkDomainToRegister?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"hostname": "domain", "zone_id": 3, "period":1}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/domain/checkDomainToRegister?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22hostname%22%3A+%22domain%22%2C+%22zone_id
%22%3A+3%2C+%22period%22%3A1%7D



Response example:


{
   "may_be_registered":true, // is the domain available for registration 
                             // (based on WHOIS service)

   "bonus_domains":0,        // current number of bonus domains 
                             // on account in selected zone

   "balance":289.46,         // current account balance

   "pay_type":null,          // payment type for domain registration. Can be:
                             // null - domain cannot be paid;
                             // money - payment will be performed from account balance;
                             // bonus_domain - payment will be performed on expense of a bonus.
                                                   
   "price":350,              // total price of domain registration 
                             // (considering the period)

   "in_system":false         // does such a domain already exist 
                             // in the BeGet system
}



Annotation:
For a final decision about the possibility of registering the domain three fields must be analyzed: may_be_registered, pay_type и in_system

Required values:

may_be_registered - true
pay_type - money or bonus_domain
in_system - false

When making an application for domain registration, you will need to pass the pay_type, which was returned by the method.


getDomainPersons
Description:
Method returns a list of saved persons, available for domain registration.


Call example:


https://api.beget.de/api/domain/getDomainPersons?login=userlogin&
passwd=password&output_format=json



Response example:


 {
   "physical":[                // person type (private person)

      {

         "id":"5214",             // individual person ID

         "name":"Иванов Петр Васильевич", // person name

         "status":"2",            // person status. 
                                  // The last used person of its type has 
                                  // status 2. The remaining persons 
                                  // have status 1.

         "fields":{
            "fio_en":"John Smith",          // Full name: First name, last name
                                                

            "date_of_birth":"10.09.1980",      // Person's date of birth

            "passport_series":"40 04",         // Passport series

            "passport_number":"123456",        // Passport number

            "passport_date":"20.10.2009",      // Date of issue

            "passport_org":"issued by Berlin city",      // Passport issued by

            "inn":"",                          // Person's tax number
                                               // mandatory for legal persons, 
                                               // optional for private persons
           
            "city_en":null,                    // City

            "state_en":null,                   // Region/state

            "postcode":null,                   // ZIP code

            "local_address_en":null,           // Domain owner address: 
                                               // street, house, apartment

            "phone":"+49 123 1234567",          // Contact number

            "email":"webmaster@gmail.com",     // Contact E-mail

            "country":"DE",                    // Two-letter ISO country code 
                                               // in upper case

         
         }
      }
   ],
   "org":[                    // person type (legal person)
      {
         "id":"1632",
         "name":"\"BeGet\" GmbH",
         "status":"2",
         "fields":{
           "org_name_en":"BeGet GmbH",       // Organization name
                                              // (minimum 2 words)
                                              

            "inn":"1234567890",               // company tax number


            "address_post_en":"123456, Berlin, Otto-Suhr-Allee 27", // Complete 
                                              // postal address of the organization

            "cont_name_en":"John",            // First name of contact person

            "cont_surname_en":"Smith",       // Last name of contact person

            "postcode":123456,                // ZIP code of organization

            "city_en":Berlin,                 // City

            "state_en":Berlin,                // Region/state

            "local_address_en":null,          // Address: street, house, office

            "phone":"+49 123 1234567",         // Contact number

            "country":"DE",                   // Two-letter ISO country code 
                                              // in upper case

            "email":"webmaster@gmail.com",    // Contact e-mail

         }
      }
   ]
}



Annotation:
Data in person fields will be used for domain registration. It is advisable to bive real data of the actual domain owner.

Some fields of the response might contain the value null or an empty string. This happens when this field has never been filled before (different domain zones require different fields). A field is mandatory if not stated otherwise.


registerVirtual
Description:
Method adds domain and makes application for its registration.


Additional parameters
hostname - domain name without zone;
zone_id - zone id. You can receive a zone list via the method getZoneList;
period - registration period;
pay_type - payment type;
person_type - type of used person;
person_id - basic person ID, type int;
person_fields - person fields, array;
pp - shall private data be hidden (mandatory in .ru / .su / .рф zones) (0/1);
enable_auto_renew - enable automatic domain renewal (0/1).


Call example:


// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/domain/registerVirtual?login=userlogin&
passwd=password&input_format=json&output_format=json&input_data=
{"hostname":"newname","zone_id":1,"period":1,"pay_type":"money",
"person_type":"physical","person_id":"1553","person_fields":
"date_of_birth":"10.09.1980","passport_series":"40 04",
"passport_number":"123456","passport_date":"20.10.2009",
"passport_org":"issued by Berlin city","inn":"","city_en":null,
"state_en":null,
"postcode":null,"local_address_en":null,
"phone":"+7 123 1234567","email":"webmaster@gmail.com",
"country":"DE",
"pp":1,"enable_auto_renew":1}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/domain/registerVirtual?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22hostname%22%3A%22newname%22%2C%22zone_id
%22%3A1%2C%22period%22%3A1%2C%22pay_type%22%3A%22money%22
%2C%22person_type%22%3A%22physical%22%2C%22person_id%22%3
A%221553%22%2C%22person_fields%22%3A%7B%22fio_ru%22%3A%22
%D0%98%D0%B2%D0%B0%D0%BD%D0%BE%D0%B2+%D0%9F%D0%B5%D1%82%D
1%80+%D0%92%D0%B0%D1%81%D0%B8%D0%BB%D1%8C%D0%B5%D0%B2%D0%
B8%D1%87%22%2C%22fio_en%22%3A%22Petr+V+Ivanov%22%2C%22dat
e_of_birth%22%3A%2210.09.1980%22%2C%22passport_series%22%
3A%2240+04%22%2C%22passport_number%22%3A%22123456%22%2C%2
2passport_date%22%3A%2220.10.2009%22%2C%22passport_org%22
%3A%22%D0%B2%D1%8B%D0%B4%D0%B0%D0%BD+10+%D0%9E%D0%9C+%D0%
B3.+%D0%9C%D0%BE%D1%81%D0%BA%D0%B2%D1%8B%22%2C%22inn%22%3
A%22%22%2C%22city_en%22%3Anull%2C%22state_en%22%3Anull%2C
%22postcode%22%3Anull%2C%22local_address_en%22%3Anull%2C%
22phone%22%3A%22%2B7+123+1234567%22%2C%22email%22%3A%22we
bmaster%40gmail.com%22%2C%22country%22%3A%22RU%22%2C%22ad
dress_post_ru%22%3A%22123456%2C+%D0%9C%D0%BE%D1%81%D0%BA%
D0%B2%D0%B0%2C+%D1%83%D0%BB.+%D0%9B%D0%B5%D0%BD%D0%B8%D0%
BD%D0%B0%2C+%D0%B4.+1%2C+%D0%BA%D0%B2.+1%22%7D%2C%22pp%22
%3A1%2C%22enable_auto_renew%22%3A1%7D%7D



Response example:


{
   "person_id":"1234", // person id, used for registration;
                       // This id will match the ide of the passed person,
                       // if its fields haven't been changed. 
                       // If the key person field has been edited, 
                       // the id of the new person will be returned, which has been created, 
                       // based on the basic person. 
                       // If any fields except the key field have been changed, 
                       // the new id of the same person will be returned. 
                       // In this case the person may only me accessed  
                       // with the new id.

   "domain_id":"123456", // id of added domain;

   "pay_type":"money"    // actually used payment type.
}



If the method was executed successfully, an application for domain registration will be created in BeGet domain registration system.

If all person data was given correctly, it will be processed automatically within 10-15 minutes. Upon processing, the domain will be registered, which an appropriate message to the account e-mail will inform you about.

If the given person data is incorrect or false, the registration application can be annulled. In this case spent funds will be returned to the account. To make a new application for domain registration, first delete the domain itself, then leave a new application for registration of this domain.

Annotation:
We highly recommend to perform a query for information on the possibility of domain registration before requesting domain registration - method checkDomainToRegister. This will allow to determine the possibility of domain name registration, registration price and operation payment type exactly.

Parameter pay_type
This parameter is in charge of the domain registration payment type. It must contain the payment type, which has been suggested upon performing the request for information on the domain registration possibility by the method checkDomainToRegister.

Parameter person_id
Here you need to indicate the identifier of the person, whose fields will be passed in the parameter person_fields. If you need to edit a person, pass its id and a new field set for it in compliance with the description below. A new person id will be returned, the old id will become inaccessible for usage.
If no person has been created for the user, the value -1 needs to be passed as this parameter. In this case a new person will be created.

Parameter person_fields
As this parameter you need to pass that part of person fields, which is required for domain registration. The field set depends on the used person type (parameter person_type) and the zone, where the domain will be registered (international / national zone). See the field description in the method getDomainPersons.

National zone, private person
For this zone you need to pass the following person fields: fio_ru, fio_en, date_of_birth, passport_series, passport_number, passport_date, passport_org, address_post_ru, country, phone, email, country.
The field inn can also be passed.

National zone, legal person
For this zone you need to pass the following person fields: org_name_ru, org_name_en, inn, kpp, address_post_ru, address_legal_ru, phone, email

International zone, private person
For this zone you need to pass the following person fields: fio_ru, fio_en, passport_series, passport_number, passport_date, passport_org, date_of_birth, postcode, city_en, state_en, local_address_en, phone, email, country

International zone, legal person
For this zone you need to pass the following person fields: org_name_ru, org_name_en, inn, cont_name_en, cont_surname_en, address_post_ru, postcode, city_en, state_en, local_address_en, phone, email.


getRenewInfo
Description:
Method returns information about domain renewal possibility and way.


Additional parameters
id - id домена;
period - desired renewal period.


Call example:


// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/domain/getRenewInfo?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"id":1000,"period":1}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/domain/getRenewInfo?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22id%22%3A1000%2C%22period%22%3A1%7D



Response example:


{
      "price_renew":1200,  // total renewal price
      "min_period":"1",    // minimum domain renewal period in zone  
      "max_period":"1",    // maximum domain renewal period in zone
      "balance":1339.57,   // current user balance
      "tld_id":"393",      // domain zone id
      "bonus_domains":"5", // number of bonus domains in this zone on account
      "pay_type":"money"   // domain registration payment type
}



Annotation:
When making an application for domain renewal, you will need to pass the pay_type, returned by this method.


renew
Description:
Method leaves an application for renewal of given domain name for given period.


Additional parameters
id - domain id;
pay_type - payment type;
period - desired renewal period.


Call example:


// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/domain/getRenewInfo?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"id":1000,"pay_type":"money","period":1}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/domain/getRenewInfo?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22id%22%3A1000%2C%22pay_type%22%3A%22
money%22%2C%22period%22%3A1%7D



Response example:


 true



Returns property of successful or unsuccessful execution.

Annotation:
Before applying the method, make sure the domain can be renewed (the appropriate flag is presented in properties of each domain when receiving the domain list via getList).
Also before making an application for domain renewal, you need to find out the payment type and the renewal price. You can do this via the method getRenewInfo. As payment type, indicate the payment type, contained in the response of the method named above.

Upon successful application for domain renewal, it will be processed automatically within 3 hours from the moment of sending the application. You will receive a message on the contact e-mail address of your account upon successful domain renewal.