Resellers API
1. 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.
- API is available via HTTPS;
- API test and run-time versions are available and can be found at https://demo-api.evonames.com and https://hiapi.evonames.com respectively;
- Requests are sent over https://hiapi.evonames.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
https://demo-api.evonames.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.
2. 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 |
|
domainRegister | Domain registration |
|
domainsRegister | Domains registration |
|
domainGetInfo | Get information of the domain |
|
domainsGetInfo | Get information of given domains |
|
domainSetNote | Set client note for the domain |
|
domainsSetNote | Set client note for given domains |
|
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.evonames.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.evonames.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.
https://demo-api.evonames.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.evonames.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.evonames.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.evonames.com/domainSetNote?auth_login=demo&auth_password=demo&domain=test.com¬e=abc
2.7. domainsSetNote
https://demo-api.evonames.com/domainsSetNote?auth_login=demo&auth_password=demo&0[domain]=test.com&0[note]=abc&1[domain]=test3.com&1[note]=def
3. 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 |
4. Command directory
Command | Description | Arguments |
---|---|---|
domainsCheck | Domains availability check |
|
domainsSearch | List/Search domains |
|
domainRegister | Domain registration |
|
domainsRegister | Register domains |
|
domainTransfer | Start domain transfer |
|
domainsTransfer | Start domains transfer |
|
domainGetNSs | Get name servers of the domain |
|
domainsGetNSs | Get name servers of domains |
|
domainSetNSs | Set name servers for the domain |
|
domainsSetNSs | Set name servers for given domains |
|
domainGetNote | Get domain note |
|
domainsGetNote | Get domains note |
|
domainSetNote | Set client note for the domain |
|
domainsSetNote | Set client note for given domains |
|
domainRenew | Domain renew |
|
domainGetPassword | Get domain password |
|
domainsGetPassword | Get domains password |
|
domainRegenPassword | Domain regen password |
|
domainsRegenPassword | Domains regen password |
|
domainGetInfo | Get information of the domain |
|
domainsGetInfo | Get information of given domains |
|
domainGetContacts | Get contacts of the domain |
|
domainGetWPContacts | Get WHOIS protected contacts of the domain |
|
domainGetContactsInfo | Get contacts info of the domain |
|
domainGetWPContactsInfo | Get WHOIS protected contacts info of the domain |
|
domainsGetContacts | Get contacts of given domains |
|
domainsGetWPContacts | Get WHOIS protected contacts of given domains |
|
domainsGetContactsInfo | Get contacts info of given domains |
|
domainsGetWPContactsInfo | Get WHOIS protected contacts info of given domains |
|
domainSetContacts | Set domain contacts |
|
domainsSetContacts | Set contacts for given domains |
|
domainEnableAutorenewal | Enable autorenewal for the domain |
|
domainDisableAutorenewal | Disable autorenewal for the domain |
|
domainsEnableAutorenewal | Enable autorenewal for given domains |
|
domainsDisableAutorenewal | Disable autorenewal for given domains |
|
domainEnableWhoisProtect | Enable whois protect for the domain |
|
domainDisableWhoisProtect | Enable whois protect for the domain |
|
domainsEnableWhoisProtect | Enable whois protect for given domains |
|
domainsDisableWhoisProtect | Disable whois protect for given domains |
|
domainEnableLock | Enable lock for the domain |
|
domainDisableLock | Disable lock for the domain |
|
domainsEnableLock | Enable lock for given domains |
|
domainsDisableLock | Disable lock for given domains |
|
domainGetDNS | Get DNS settings for given domain |
|
domainsGetDNS | Get DNS settings for given domains |
|
domainSetDNS | Set DNS settings for given domain |
|
domainsSetDNS | Set DNS settings for given domains |
|
hostsSearch | Hosts search |
|
hostGetInfo | Host get info |
|
hostsGetInfo | Hosts get info |
|
hostCreate | Host create |
|
hostsCreate | Hosts create |
|
hostUpdate | Host update |
|
hostsUpdate | Hosts update |
|
contactsSearch | List/Search contacts |
|
contactGetInfo | Get contact info |
|
contactsGetInfo | Get contacts info |
|
contactCreate | Create contact |
|
contactsCreate | Create contacts |
|
contactUpdate | Update contact |
|
contactsUpdate | Update contacts |
|
clientGetBalance | Get client balance |
|
clientGetPrices | Get client prices |
|
clientsGetPrices | Get clients prices |
|