Reseller API

We provide full featured HTTP API for all our resellers.

General information

Attention!

API is not intended to catch the dropping domains. The restrictions on the number of ENQs are introduced. Non-observance will result in a ban.
We have special interface for catching.

Sometimes the operation can take up to 10 minutes due to circumstances beyond our control. Therefore set 10 minutes timeout for the API response.

  • API is available via HTTPS;
  • API test and run-time versions are available and can be found at https://demo-api.domaincontext.com and https://api.domaincontext.com respectively;
  • Requests are sent over https://api.domaincontext.com/apiCommand. Request data are transferred via GET or POST variables;
  • There are variables such as auth_login and auth_password used for authorization;
  • The results of the request are returned encoded in JSON;
  • In case of an error there will be "_error" element in a returned array. This key will contain the description of the error;
  • Acceptable request results may be:
    • scalar "true"
    • an array which does not contain "_error" element
    • any other result including the blank is an error
Example:
https://demo-api.domaincontext.com/domainsCheck?auth_login=demo&auth_password=demo&domains=test.com,adfwer234asdf.net

This is a run-time example. You may copy URL, paste it in Web browser and see the errors.

Detailed examples

The table shows an extract from a directory that contains a full list of available commands.

Command Description Arguments
domainsCheck Domains availability check
  • domains — domains, *
domainRegister Domain registration
  • domain — domain, *
  • period — period, по умолчанию: 1 год
  • sometimes the operation can take up to 10 minutes due to circumstances beyond our control. therefore set 10 minutes timeout for the api response.
domainsRegister Domains registration
  • array of — domainRegister
  • sometimes the operation can take up to 10 minutes due to circumstances beyond our control. therefore set 10 minutes timeout for the api response.
domainGetInfo Get information of the domain
  • domain — domain
  • id — id
domainsGetInfo Get information of given domains
  • array of — domainGetInfo
domainSetNote Set client note for the domain
  • domain — domain
  • note — label
  • id — id
domainsSetNote Set client note for given domains
  • array of — domainSetNote
domainsSetDNS Set DNS settings for given domain
  • array of — domainSetDNS
serverBuy Buy server
  • tariff - label,*
  • cluster_id - id,* (one of: 1 - Netherlands, Amsterdam, 2 - USA, Ashburn)
  • osimage - eid,* (available values can be obtained with command osimagesSearch)
  • panel - ref
  • social - label
  • purpose - label
  • callback_url - url

2.1. domainsCheck

The only argument of "domains" command is a comma delimited list of domains. It is needed to check domain availability for registration.
* - an “asterisk” means that an argument is required. It's omission provokes an error.

https://demo-api.domaincontext.com/domainsCheck?auth_login=demo&auth_password=demo&domains=test.com,adfwer234asdf.net

2.2. domainRegister

Be sure to type only a domain name. Other parameters provide defaults.

https://demo-api.domaincontext.com/domainRegister?auth_login=demo&auth_password=demo&domain=test42345.com

2.3. domainsRegister

An example of bulk-operation conducted upon several objects at the same time. A word “array” is used in the description of arguments. It means that the array has to be transferred and its every element fits as an argument for a stated operation. In our case it is domainRegister.

sometimes the operation can take up to 10 minutes due to circumstances beyond our control. therefore set 10 minutes timeout for the api response.

https://demo-api.domaincontext.com/domainsRegister?auth_login=demo&auth_password=demo&0[domain]=test42345.com&1[domain]=test123123.net

2.4. domainGetInfo

It is very easy – here you need to transfer a name or ID of a domain. It sends back domain array of data.

https://demo-api.domaincontext.com/domainGetInfo?auth_login=demo&auth_password=demo&domain=test42345.com

2.5. domainsGetInfo

Bulk-operation - upon several objects at the same time.

https://demo-api.domaincontext.com/domainsGetInfo?auth_login=demo&auth_password=demo&0[domain]=test42345.com&1[domain]=test.com

2.6. domainSetNote

Blank or not indicated “note” – deletes any note.

https://demo-api.domaincontext.com/domainSetNote?auth_login=demo&auth_password=demo&domain=test.com&note=abc

2.7. domainsSetNote

https://demo-api.domaincontext.com/domainsSetNote?auth_login=demo&auth_password=demo&0[domain]=test.com&0[note]=abc&1[domain]=test3.com&1[note]=def

2.8. domainsSetDNS

https://demo-api.domaincontext.com/domainsSetDNS?auth_login=demo&auth_password=demo&5504202[1][type]=a&5504202[1][value]=123.123.123.123&5504202[1][no]=1&5504202[1][ttl]=7200&5504202[1][status]=new

2.9. serverBuy

https://demo-api.domaincontext.com/serverBuy?auth_login=demo&auth_password=demo&tariff=XENSSD%20VDS%204%20100+&os=centos&panel=isp&cluster_id=1&social=test&purpose=test&callback_url=http:\/\/my.domain.com\/page\/for\/callback

Type directory

Type Description
* Required field, a value should not be empty, not zero, not a blank line and not an empty list.
Fields without a star are optional and may be omited while calling the command.
id ID. An integer more than zero.
For example: 314123
ids ID list, comma delimited, space symbols are allowed.
For example: 1234, 324534, 223423
domain Domain name
For example: domain.com
domains List of domains, comma delimited, space symbols are allowed.
For example: domain.com, asdf.net
ns Name servers name.
For example: ns1.domain.com
nss Name servers list, comma delimited, space symbols are allowed.
For example: ns1.domain.com, ns2.domain.com
eid Extended ID. Numbers, Latin letters and symbols (underlining, dot, colon, minus) are allowed.
For example: EID_234234:234—1
password Password (64 symbols max). It should not contain line break symbols: \n, \r.
For example: We\p!Jie6w
period An integer from 1 to 10. It is used to indicate an amount of years when registering or prolonging.
For example: 1
date
expires		 Date in ISO format.
For example: 2012—09—25
ref Identifier (ID). It consists of several numbers, Latin letters and underlining. There is no limitation on the first symbol.
For example: ok
For example: 7days
For example: 0001
refs ID list, comma delimited, space symbols are allowed.
For example: ok, nok, 123
label Almost no limitation on the line. Line break symbols are not allowed.
For example: This is a client’s name – Ivan Drago
labels Line list, comma delimited, space symbols are allowed. Array transmission is allowed.
For example: Ivan, Peter, Fedor, John
dnsName An empty string, "*", "@", or string not longer than 100 symbols, composed of not more than 4 parts, separated by ".", each of which consists of 1-61 symbols of following types:latin characters, numbers or -" and "_"characters ("-" may not be the first and last symbol).
For example: *, @, n1, a1.b2, a1.b2.c3, a1.b2.c3.d4

Command directory

Command Description Arguments
domainsCheck Domains availability check
  • domains — domains, *
domainsSearch List/Search domains
  • ids — ids
  • domain — label
  • domains — labels
  • note — labels
  • state — ref
  • client — labels
  • seller — labels
  • orderby — ref
  • limit — id
  • total — id
  • page — id
  • count — bool
  • show_dns — bool
  • show_fw_park — bool
  • dns — ref
  • view — ref
domainRegister Domain registration
  • domain — domain, *
  • period — period — defaults to: 1 year
  • registrant — eid
  • admin — eid
  • tech — eid
  • billing — eid
  • sometimes the operation can take up to 10 minutes due to circumstances beyond our control. therefore set 10 minutes timeout for the api response.
domainsRegister Register domains
  • array of — domainRegister
  • sometimes the operation can take up to 10 minutes due to circumstances beyond our control. therefore set 10 minutes timeout for the api response.
domainCheckTransfer Check data for domain transfer
  • domain — domain, *
  • password — password, *
domainsCheckTransfer Check data for domains transfer
  • array of — domainCheckTransfer
domainTransfer Check data for domains transfer
  • domain — domain, *
  • password — password, *
domainsTransfer Start domains transfer
  • array of — domainTransfer
domainApprovePreincoming Approve domains transfer
  • domains — list of domains, comma separeted
  • confirm_data - array of data from message
domainsRejectPreincoming Cancel domains transfer
  • domains - list of domains, comma separeted
  • confirm_data - array of data from message
domainGetNSs Get name servers of the domain
  • domain — domain
  • id — id
domainsGetNSs Get name servers of domains
  • array of — domainGetNSs
domainSetNSs Set name servers for the domain
  • domain — domain
  • nss — nss
  • id — id
domainsSetNSs Set name servers for given domains
  • array of — domainSetNSs
domainGetNote Get domain note
  • domain — domain
  • id — id
domainsGetNote Get domains note
  • array of — domainGetNote
domainSetNote Set client note for the domain
  • domain — domain
  • note — label
  • id — id
domainsSetNote Set client note for given domains
  • array of — domainSetNote
domainRenew Domain renew
  • domain — domain, *
  • period — period, *
  • expires — expires, * — current expiration date
domainGetPassword Get domain password
  • domain — domain
  • pincode — pincode
  • id — id
domainsGetPassword Get domains password
  • array of — domainGetPassword
domainRegenPassword Domain regen password
  • domain — domain
  • pincode — pincode
  • id — id
domainsRegenPassword Domains regen password
  • array of — domainRegenPassword
domainGetInfo Get information of the domain
  • domain — domain
  • id — id
domainsGetInfo Get information of given domains
  • array of — domainGetInfo
domainGetContacts Get contacts of the domain
  • domain — domain
  • id — id
domainGetWPContacts Get WHOIS protected contacts of the domain
  • domain — domain
  • id — id
domainGetContactsInfo Get contacts info of the domain
  • same as — domainGetContacts
domainGetWPContactsInfo Get WHOIS protected contacts info of the domain
  • same as — domainGetContactsInfo
domainsGetContacts Get contacts of given domains
  • array of — domainGetContacts
domainsGetWPContacts Get WHOIS protected contacts of given domains
  • array of — domainGetContacts
domainsGetContactsInfo Get contacts info of given domains
  • array of — domainGetContacts
domainsGetWPContactsInfo Get WHOIS protected contacts info of given domains
  • array of — domainGetContacts
domainSetContacts Set domain contacts
  • domain — domain
  • id — id
  • registrant — eid, *
  • admin — eid, *
  • tech — eid, *
  • billing — eid, *
domainsSetContacts Set contacts for given domains
  • array of — domainSetContacts
domainEnableAutorenewal Enable autorenewal for the domain
  • domain — domain
  • id — id
domainDisableAutorenewal Disable autorenewal for the domain
  • same as — domainEnableAutorenewal
domainsEnableAutorenewal Enable autorenewal for given domains
  • array of — domainEnableAutorenewal
domainsDisableAutorenewal Disable autorenewal for given domains
  • array of — domainEnableAutorenewal
domainEnableWhoisProtect Enable whois protect for the domain
  • domain — domain
  • id — id
domainDisableWhoisProtect Enable whois protect for the domain
  • same as — domainEnableWhoisProtect
domainsEnableWhoisProtect Enable whois protect for given domains
  • array of — domainEnableWhoisProtect
domainsDisableWhoisProtect Disable whois protect for given domains
  • array of — domainEnableWhoisProtect
domainEnableLock Enable lock for the domain
  • domain — domain
  • id — id
domainDisableLock Disable lock for the domain
  • same as — domainEnableLock
domainsEnableLock Enable lock for given domains
  • array of — domainEnableLock
domainsDisableLock Disable lock for given domains
  • array of — domainEnableLock
domainGetDNS Get DNS settings for given domain
  • id — id
  • domain — domain
domainsGetDNS Get DNS settings for given domains
  • array of — domainGetDNS
domainSetDNS Set DNS settings for given domain
  • array of {
    • name — dnsName
    • type — ref
    • value — label
    • no — id
    • ttl — id
    • status — ref (ok,new,deleted)
    }
domainsSetDNS Set DNS settings for given domains
  • array of — domainSetDNS
domainPush Push domain to given client
  • domain — domain
  • id — id
  • sender — client, *
  • receiver — client, *
  • pincode — pincode
domainsPush Push domains to given receivers
  • array of — domainPush
hdomainGetDNS Get DNS settings for given domain
  • id — id
hdomainsGetDNS Get DNS settings for given domains
  • array of — hdomainGetDNS
hdomainSetDNS Set DNS settings for given domain
  • array of {
    • name — dnsName
    • type — ref
    • value — label
    • no — id
    • ttl — id
    • status — ref (ok,new,deleted)
    }
hdomainsSetDNS Set DNS settings for given domains
  • array of — domainSetDNS
hostsSearch Hosts search
  • ids — ids
  • host — labels
  • domain — labels
  • domain_ids — ids
  • note — labels
  • client — labels
  • seller — labels
  • orderby — ref
  • limit — id
  • total — id
  • page — id
  • count — bool
hostGetInfo Host get info
  • id — id
  • host — ns
hostsGetInfo Hosts get info
  • array of — hostGetInfo
hostCreate Host create
  • host — ns, *
  • ips — ips
hostsCreate Hosts create
  • array of — hostCreate
hostUpdate Host update
  • id — id
  • host — ns
  • ips — ips
hostsUpdate Hosts update
  • array of — hostUpdate
hostDelete Host delete
  • id — id
  • host — ns
hostsDelete Hosts delete
  • array of — hostDelete
contactsSearch List/Search contacts
  • ids — ids
  • name — labels
  • email — labels
  • client — labels
  • seller — labels
  • select — ref
  • orderby — ref
  • limit — id
  • total — id
  • page — id
  • count — bool
contactGetInfo Get contact info
  • id — eid, *
contactsGetInfo Get contacts info
  • array of — contactGetInfo
contactCreate Create contact
  • email — email, *
  • first_name — label, *
  • last_name — label
  • birth_date — date
  • organization — label
  • street1 — label, *
  • street2 — label
  • street3 — label
  • city — label, *
  • province — label
  • postal_code — label, *
  • country — ref, *
  • voice_phone — phone, *
  • fax_phone — phone
  • emails — emails
  • type — ref — one of: person, organization
  • passport_no — label
  • passport_date — date
  • passport_by — label
  • organization_ru — label — for .ru zone only
  • inn — label — for .ru zone only
  • kpp — label — for .ru zone only
  • director_name — label — for .ru zone only
  • isresident — boolean — for .ru zone only
contactsCreate Create contacts
  • array of — contactCreate
contactUpdate Update contact
  • id — id,*
  • pincode — pincode
  • email — email, *
  • first_name — label, *
  • last_name — label
  • birth_date — date
  • organization — label
  • street1 — label, *
  • street2 — label
  • street3 — label
  • city — label, *
  • province — label
  • postal_code — label, *
  • country — ref, *
  • voice_phone — phone, *
  • fax_phone — phone
  • emails — emails
  • passport_no — label
  • passport_date — date
  • passport_by — label
  • organization_ru — label
  • inn — label
  • kpp — label
  • director_name — label
  • isresident — boolean
contactsUpdate Update contacts
  • array of — contactUpdate
contactDelete Contact delete
  • id — id,*
contactsDelete Contacts delete
  • array of — contactDelete
clientCheck Check client login/password
  • login — client
  • password — passwrod
clientCreate Create new client
  • login — client, *
  • password — password, *
  • seller — client, *
  • all the fields from contactCreate
clientGetBalance Get client balance
  • id — id
  • client — client
  • currency — ref
clientGetPrices Get client prices
  • client — client
  • id — id
  • seller — client
  • seller_id — id
clientsGetPrices Get clients prices
  • array of — clientGetPrices
tariffsGetAvailable Get list of available tariffs
  • seller - client
  • type - ref (one of: domain, ovds, svds)
tariffGetInfo Get tariff info
  • id - id
tariffsGetInfo Get tariffs info
  • array of - tariffGetInfo
serversSearch Search servers
  • ids - ids
  • servers - servers
  • note - labels
  • client - client
  • seller - client
  • states - refs
  • orderby - ref
  • limit - id
  • page - id
serversGetList Get servers list
  • ids - ids
  • server - server
  • client - client
serverGetList Get servers list
  • array of - serverGetList
serverGetInfo Get server info
  • id - id
  • server - server
serversGetInfo Get servers info
  • array of - serverGetInfo
serverBuy Buy server
  • tariff - label,*
  • cluster_id - id,* (one of: 1 - Netherlands, Amsterdam, 2 - USA, Ashburn)
  • osimage - eid,* (available values can be obtained with command osimagesSearch)
  • panel - ref
  • social - label
  • purpose - label
  • callback_url - url
  • amount - id, period, default 1
serversBuy Buy servers
  • array of - serverBuy
serverRenew Renew server
  • server - server name
  • id - id
  • amount - id, period, default 1
serversRenew Renew servers
  • array of - serverRenew
serverRefuse Refuse from server
  • id - id
  • server - server
serverReboot Reboot server
  • id - id
  • server - server
serversReboot Reboot servers
  • array of - serverReboot
serverReset Reset server
  • id - id
  • server - server
serversReset Reset servers
  • array of - serverReset
serverShutdown Shutdown server
  • id - id
  • server - server
serversShutdown Shutdown servers
  • array of - serverShutdown
serverPowerOn Server power on
  • id - id
  • server - server
serversPowerOn Servers power on
  • array of - serverPowerOn
serverPowerOff Server power off
  • id - id
  • server - label
serversPowerOff Servers power off
  • array of - serverPowerOff
serverResetup Resetup server
  • id - id
  • server - server
  • osimage - eid,* (see serverBuy)
  • panel - ref (see serverBuy)
serversResetup Resetup servers
  • array of - serverResetup
serverEnableVNC Enable VNC for server
  • id - id
  • server - label
serversEnableVNC Enable VNC for servers
  • array of - serverEnableVNC
serverRegenRootPassword Regenerate root password for server
  • id - id
  • server - server
serversRegenRootPassword Regenerate root password for servers
  • array of - serverRegenRootPassword
serverBootLive Boot server from Live CD
  • id - id
  • server - server
  • osimage - eid (one of: freebsdx64.live, gentoox64.live)
serversBootLive Boot server from Live CD
  • array of - serverBootLive
osimagesSearch Get list of available OS images
  • type - ref (one of: svds - XEN, ovds - OpenVZ)
certificatesSearch Certificates search
  • id - id
  • remoteid - eid
  • parent_id - id
  • is_parent - boolean
  • type_id - id
  • product_id - id
  • state_id - id
  • object_id - id
  • client_id - id
  • seller_id - id
  • name - label
  • type - ref
  • type_label - label
  • state - ref
  • client - client
  • seller - client
  • amount - period
  • begins - date
  • expires - date
  • show_chain - boolean
  • show_new - boolean
certificateGetInfo Get certificate info from DB
  • id - id, *
certificatesGetInfo et certificates info from DB
  • array of certificateGetInfo
certificateGetData Get certificate data
  • id - id, *
certificatesGetData Get certificates data
  • array of certificatesGetData
certificatePurchase Purchase certificate
  • product - ref
  • product_id - id
  • amount - period
  • client - client
  • client_id - id
  • object_id - id
  • coupon - coupon
certificatesPurchase Purchase certificates
  • array of certificatePurchase
certificateIssue Issue certificate
  • id - id, *
  • admin_id - id, *
  • tech_id - id, *
  • org_id - id
  • dcv_method - ref, *
  • approver_email - email
  • approver_emails - emails
  • webserver_type - ref
  • dns_names - hdomains
  • csr - text, *
certificatesIssue Issue certificates
  • array of certificateIssue
certificateReissue Reissue certificate
  • same as certificateIssue
certificatesReissue Reissue certificates
  • array of certificateReissue
certificateCancel Cancel certificate
  • id - id, *
  • reason - label, *
certificatesCancel Cancel certificates
  • array of certificateCancel
certificateRenew SSL order renew
  • id - id, *
  • expires - date, *
certificatesRenew SSL orders renew
  • array of certificateRenew
certificateGenerateCSR Create CSR for certificate
  • csr_commonname - label, *
  • csr_organization - label, *
  • csr_department - label, *
  • csr_city - label, *
  • csr_state - label, *
  • csr_country - label, *
  • csr_email - email, *
  • copy_to_email - boolean
  • client - client
  • client_id - id
certificateGenerateCsr Create CSR for certificate
  • same as certificateGenerateCSR
certificateDecodeCSR Decode CSR
  • csr - text
  • brand - ref
  • wildcard - bool
certificateDecodeCsr Create CSR for certificate
  • same as certificateDecodeCSR
certificateGetWebserverTypes Get web server types
  • supplier - ref
certificateGetDomainEmails Get valid approver email addresses for specified domain
  • id - id
  • domain - domain
  • csr - text
certificateSendNotifications Send notification
  • id - id, *
certificatesSendNotifications Send notifications
  • array of certificateSendNotifications
certificateRevalidate Validate certificate
  • id - id, *
certificatesRevalidate Validate certificates
  • array of certificateRevalidate
certificateChangeValidation Change certificate validation
  • id - id, *
  • dcv_method - ref, * (available values: dns, http, https, email)
  • approver_email - email
  • approver_emails - emails
certificateChangeValidation Change certificates validation
  • array of certificatesRevalidate

Making order and other questions

Ways of organizing cooperation

Reseller site on the basis getdomen.ru

We offer our partners to get standard reseller website based on getdomen.ru
It is completely free. You just have to tell us the following information:

  • your login in the control panel;
  • domain, which will be located on the control panel;
  • ssl certificate and private key;
  • email to receive all notification;
  • web-service address, which will appear in the Whois service of registered domain;
  • payment systems, which will be available for payment on your site (you can connect WebMoney, PayPal, eCoin, ePayService / EPSBanking, Paxum, OkPay).
  • contact details for publishing on the web-site (ICQ, Skype — optional);
  • languages, that will be available by default on the web-site (Russian/English).

Upon receipt of followed information, we will give you IP-address, on which will need to create A record.

To become a reseller of AHnames domains you have to contact us via email, ICQ or Skype:

Mailsupport@getdomen.ru
It's important!

Save the request for purchasing an SSL Certificate (CSR) and private key (RSA).
After purchasing the SSL certificate, you have to provide us with self SSL certificate and private key (RSA).
To generate the request for SSL you can on this page: ssl.com.ua/online-CSR-generator

© 2024 getdomen.ru. All rights reserved. Powered by HiPanel