1、URL

The HTTP API address is ：http://api.eranet.com:2080

2、Verification

All requests sent require the following validation parameters：

auth-userid: Your current agent account ID (check your agent ID)

api-key: A string of alphanumeric codes used to authenticate API commands (read the following prompt to query your API key)

Be careful： Auth userid and API key are all in get request mode. Please refer to HTTP mode requirements for interface business parameters.

3、Find your agent ID, API key, and authorized IP

1.Log in to your dealer control panel

2.On the top of the function bar on the left, the agent number is usually six to seven digits, which is the agent ID

3.Find "modify and reset API key" under "HTTP API interface management" in the function bar on the left. The API verification password, that is, API key, can be generated initially, or the API password can be modified on the same page

4.In the left function bar, find "change interface authentication IP" under "HTTP API interface management". You can authorize the server IP you want to call the interface to authorize. Without authorization, you cannot use the interface

Be careful

Regenerating a new API key means that your old API key will fail immediately, which will fail to verify your existing API

4、API

The HTTP API requires that all requests for retrieving data should be submitted using the get method, and requests for changing and deleting data should use the post method. If you do not use the correct method to send the request, the request for the special HTTP method will return an error value. However, to make it easier for you to test APIs with browsers and command-line tools, we provide a test URL that allows you to use get

1、Describe

Query whether a specific domain name can be registered

2、Parameter

Name	Data Type	Required / Optional	Describe
auth-userid	Integer	Must fill	Certification parameter agent ID
api-key	String	Must fill	Authentication Parameter Authentication parameter API KEY
domain-name	String Array	Must fill	Domain name to query
tlds	String Array	Must fill	Top level domain suffix of domain name to be queried

3、HTTP mode

GET

4、Test URL request example

/api/domains/available.json?auth-userid=0&api-key=key&domain-name=domain1&domain-name=domain2&tlds=com&tlds=net

5、Interface return value Top

Returns a hash map containing the availability status of the queried top-level domain suffix:

Domain name query status（status）

Available - domain name can be registered

Unavailable-domain name can be registered

1.Describe

Contact's basic information

Interface status: In development

Interface URL： POST https://todapi.now.cn:2443/api/contacts/query.json Content-Type： multipart/form-data

Authentication method: No authentication required

2、Parameters

Parameter Name	Parameter Value	Required: Yes/No	Parameter Type	Description
contact-id		No	String	Template ID
registrant-type	I	No	String	Enterprise or individual E enterprise I individual
company-loc		No	String	Owner name
email		No	String	e-mail address
mobile		No	String	cell-phone number
address-loc		No	String	Chinese address
page_number	1	No	String	page number

1、Describe

Add a contact to the domain name using the details provided

2、Parameter

Name	Data Type	Required / Optional	describe
auth	Integer	Must fill	Certification parameter agent ID
api-key	String	Must fill	Authentication parameter API KEY
registrant-type	String	Must fill	I:Individual E:Enterprise
name	String	Must fill	Contact name (English) (character limit 255)
name-loc	String	Must fill	Contact name (Chinese) (character limit 255)
company	String	Must fill	Company name (English) (character limit 255)
company-loc	String	Must fill	Company name (Chinese)
email	String	Must fill	Contact email address
address-line-1	String	Must fill	First line of contact address (English) (character limit 64)
address-loc-line-1	String	Must fill	First line of contact address (Chinese) (character limit 64)
city	String	Must fill	City name in English or Pinyin(If the country is CN, see the contact template "city" City Chinese or Pinyin)(character limit 64) view details
country	String	Must fill	Country code reference ISO 3166-1 alpha-2 (character limit 2)
zipcode	String	Must fill	Zip code (character limit 10)
mobile-cc	String	Must fill	Telephone country code (character limit 3)
mobile	String	Must fill	Mobile phone number (character limit 15)
phone-cc	String	Must fill	Telephone country code (character limit 3)
phone	String	Must fill	Phone number (When the country is CN, if you want to write a fixed-line phone, keep the city area code to one, see the variable agreement - City, such as mobile phone number without area code)(character limit 12)
address-line-2	String	Optional	Second line of contact address (character limit 64)
address-line-3	String	Optional	Third line of contact address (character limit 64)
state	String	Must fill	Province / state name in English or Pinyin (When the country is CN, see variable convention-Province abbreviation value)(character limit 64) view details
fax-cc	String	Must fill	Fax country code (character limit 3)
fax	String	Must fill	Fax number (When the country is CN, if you want to write a fixed-line phone, keep the city area code to one, see the variable agreement - City, such as mobile phone number without area code)(character limit 64)
ident-type	String	Not required	ID type（.cn、.中国 is required） view details
ident-no	String	Not required	ID number（.cn、.中国 is required）
Be careful： Chinese information can also be written in English, but English cannot be written in Chinese
Be careful： If it is a HK domain name, please add the following parameters
type	String	Must fill	"HkContact"
attr-name1	String	Must fill	"ident_type"
attr-value1	String	Must fill	Individual：CNID（Domestic ID card），PASSNO（Passport），OTHIDV（Other individuals） Enterprise：CNCO（Organization code certificate）,BR（Hong Kong Business Registration Certificate）,OTHORG（Other organization）
attr-name2	String	Must fill	"ident_number"
attr-value2	String	Must fill	ID number

3.HTTP mode

POST

URL request example

/api/contacts/add.json?auth-userid=0&api-key=key&name=abc&name-loc=name-loc&company=company&company-loc=company-loc&email=urname@domain.com&address-line-1=address1&address-loc-line-1=address1-loc&city=city&country=nn&zipcode=0&phone-cc=0&phone=0

4.Interface return value

Returns the contact ID (integer value) of the newly added contact. Different types of contacts can use the same name and company name

URL request example

/api/contacts/add.json?auth-userid=0&api-key=key&name=abc&name-loc=name-loc&company=company&company-loc=company-loc&email=urname@domain.com&address-line-1=address1&address-loc-line-1=address1-loc&city=city&country=nn&zipcode=0&phone-cc=0&phone=0

5.Interface response

Returns the contact ID of the newly added contact (Integer)

If an error is encountered, a status value containing error and error information is returned

1.Describe

Register a domain name

2、Parameter

Name	Data Type	Required / Optional	Describe
auth-userid	Integer	Must fill	Certification parameter agent ID
api-key	String	Must fill	Authentication parameter API KEY
domain-name	String Array	Must fill	Domain name you need to register
years	Integer	Must fill	Years of domain name you want to register
ns	Array of Strings	Must fill	DNS domain name server of domain name
reg-contact-id	Integer	Must fill	Domain name registrant contact ID
admin-contact-id	Integer	Must fill	Management contact ID of domain name
Be careful：If the domain name is a HK domain name, each contact ID cannot be the same, and the following parameters should be added (other domain names can use the same contact ID)
tech-contact-id	Integer	Must fill	Technical contact ID of the domain name
billing-contact-id	Integer	Must fill	The billing contact ID of the domain name

3.HTPP mode

POST

4.Test URL request example Top

/api/domains/register.xml?auth-userid=0&api-key=key&domain-name=domain.com&years=1&ns=ns1.domain.com&ns=ns2.domain.com ®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0

5.Interface response Top

The return value is as follows：

Domain name registration order ID(entityid)：

Domain name server Modification Description(actiontypedesc)

Domain name server modification status (actionstatus)

Domain name server modification status description(actionstatusdesc)

If any error occurs, the status returns error with an error message

1、Describe

Get the ID of the registered domain name

2、Parameter

Name	Data Type	Required / Optional	Describe
auth-userid	Integer	Must fill	Certification parameter agent ID
api-key	String	Must fill	Authentication parameter API KEY
domain-name	String	Must fill	Registered domain name to get ID

3、HTTP mode

GET

4、Test URL request example

/api/domains/orderid.json?auth-userid=0&api-key=key&domain-name=domain.com

4、Interface response

Return the ID (integer) corresponding to the registered domain name

1、Describe

Obtain relevant domain name registration order information through specific domain name ID

2、Parameter Top

Name	Data Type	Required / Optional	Describe
auth-userid	Integer	Must fill	Certification parameter agent ID
api-key	String	Must fill	Authentication parameter API KEY
order-id	Integer	Must fill	ID of domain name registration order for which information is required
options	String Array	Must fill	Value can be set to: all

3、HTTP mode

GET

4、Test URL request example

/api/domains/details.json?auth-userid=0&api-key=key&order-id=0&options=All

5、Interface response

Return a hash map containing the domain name registration order information:

Domain ID

Domain

Order description

Current status (not enabled for now ignore)

Domain name status

Creation time（Subject to the time of the registry）

Expiration date（Subject to the time of the registry

Whether the order belongs to only one customer (isimmediatereller) under the agent account (ignored if not enabled temporarily)

Registrantcontact ID

Admincontact ID

Techcontact ID

billingcontact ID

Domain name server(ns1 and ns2)

1、Describe

Renew a domain name order for a specific number of years

2、Parameter Top

Name	Data Type	Required / Optional	Describe
auth-userid	Integer	Must fill	Certification parameter agent ID
api-key	String	Must fill	Authentication parameter API KEY
order-id	Integer	Must fill	The domain name order number you want to renew
years	Integer	Must fill	The number of years you want to renew the domain name
exp-date	Integer	Must fill	The current expiration date of the order in epoch time format

3、HTTP mode

POST

4、Test URL request example

/api/domains/renew.json?auth-userid=0&api-key=key&order-id=562994&years=1&exp-date=1279012036

5、Interface response Top

The return value is as follows：

Domain name registration order ID

Domain name server Modification Description

Domain name server modification status

Domain name server modification status description

If any error occurs, the status returns error with an error message

1、Describe

Modify domain name DNS server of specified domain name order

2、Parameter

Name	Data Type	Required / Optional	Describe
auth-userid	Integer	Must fill	Certification parameter agent ID
api-key	String	Must fill	Authentication parameter API KEY
order-id	Integer	Must fill	ID of domain name registration order for which information is required
ns	String Array	Must fill	New domain name DNS server

3、HTTP mode

POST

4、Test URL request example

/api/domains/modify-ns.json?auth-userid=0&api-key=key&order-id=0&ns=ns1.domain.asia&ns=ns2.domain.asia

5、Interface response

The return value is as follows：

Modify status (actionstatus)

Modify status description (actiontypedesc)

ID of domain registration order(entityid)

Whether it is successful (success)

If any error occurs, the status returns error with an error message

1、Describe

Modify contact information for a specific domain name order

2、Parameter Top

Name	Data Type	Required / Optional	Describe
auth-userid	Integer	Must fill	Certification parameter agent ID
api-key	String	Must fill	Authentication parameter API KEY
order-id	Integer	Must fill	ID of domain name registration order for which information is required
reg-contact-id	Integer	Must fill	New registered contact ID
admin-contact-id	Integer	Must fill	New registered contact ID
tech-contact-id	Integer	Must fill	New technology contact ID
billing-contact-id	Integer	Must fill	New billing contact ID

3、HTTP mode

POST

4、Test URL request example

/api/domains/modify-contact.json?auth-userid=0&api-key=key&order-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0

5、Interface response

The return value is as follows：

Domain name registration order ID (entityid)

Domain name server Modification Description

Domain name server modification status

Domain name server modification status description

If any error occurs, the status returns error with an error message

1、Describe

Domain name transfer

Be careful :You must ensure that the domain name is unlocked

2、Parameter Top

Name	Data Type	Required / Optional	Describe
auth-userid	Integer	Must fill	Certification parameter agent ID
auth-key	String	Must fill	Authentication parameter API KEY
domain-name	String	Must fill	Specify the domain name you want to transfer
auth-code	String	Must fill	Authorization code of the domain you want to transfer (also called transfer password)
reg-contact-id	Integer	Must fill
admin-contact-id	Integer	Must fill
tech-contact-id	Integer	Must fill
billing-contact-id	Integer	Must fill

3、HTTP mode

POST

4、Test URL request example

/api/domains/transfer.json?auth-userid=0&api-key=key&order-id=0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0

5、Interface response

The return value is as follows：

Domain submission transfer status (status)

Return message (message)

If any error occurs, the status returns error with an error message

1、Describe

Submit domain name transfer password submit domain name transfer code (also known as authorization code) for the domain name being transferred to eranet

Be careful :You must ensure that the domain name is unlocked.

2、Parameter Top

Name	Data Type	Required / Optional	Describe
auth-userid	Integer	Must fill	Certification parameter agent ID
api-key	String	Must fill	Authentication parameter API KEY
order-id	Integer	Must fill	Order ID of domain name transferred in
auth-code	String	Must fill	Transfer code or authorization code of domain name transferred in

3、HTTP mode

GET

4、Test URL request example

/api/domains/transfer/submit-auth-code.xml?auth-userid=0&api-key=0&order-id=12345678&auth-code=authcodegoeshere

5、Interface response

If the authorization code provided is correct, the value success (string) will be returned, and the domain name transfer process will continue. If any error message appears, the status value will be error, and the specific error message will be returned

1、 Describe

Query domain name transfer result

2、Parameter Top

Name	Data Type	Required / Optional	Describe
order-id	Integer	Must fill	Order ID

3、HTTP mode

POST

4、Test URL request example

/api/domains/query-transfer?order-id=12345678

5、Interface response

The return value is as follows：

{"trStatus":"pending"}

1、 Describe

Real-name authentication submission interface can support real-name authentication domain name submission

2、Parameter Top

Name	Data Type	Required / Optional	Describe
tld	String	Must fill	The top-level domain suffix of the domain name to be queried (for example: cn, com, cc, etc. only support cn for the time being)
contact-id	Integer	Must fill	The established contact id who needs to submit real-name authentication
ident-type	String	Must fill	type of certificate view details
ident-no	String	Must fill	ID number
ident-image-base64	String	Must fill	Real-name authentication data picture encoded with Base64 (base64 encoded must be less than 200KB, otherwise it will return 413 Request Entity Too Large)
ident-ext-image-base64	String	Not required	The Letter of Commitment for a Real Overseas Natural Person Encoded in Base64,(Download)，which is only required if the owner is a non-Chinese domestic individual owner

3、HTTP mode

POST

4、Test URL request example

/api/contacts/real-name-submit.json?tld=com&contact-id=12345678&ident-type=JGZ&ident-no=11111&ident-image-base64=4541564646

5、Interface response

The return value is as follows：

Contact ID (entityid)

Submit domain name extension (tld)

Real-name submission status (status)

1、 Describe

Real-name result query

2、Parameter Top

Name	Data Type	Required / Optional	Describe
tld	String	Must fill	The top-level domain suffix of the domain name to be queried (for example: cn, com, cc, etc. only support cn for the time being)
contact-id	Integer	Must fill	The established contact id who needs to submit real-name authentication

3、HTTP mode

POST

4、Test URL request example

/api/contacts/real-name-query.json?tld=com&contact-id=12345678

5、Interface response

The return value is as follows：

Contact ID (entityid)

Domain suffix (tld)

Real name status (status)

1、 Describe

Agent balance inquiry

2、Parameter Top

Name	Data Type	Required / Optional	Describe
username	String	Must fill	User name
password	String	Must fill	Password

3、HTTP mode

GET

4、Test URL request example

/api/billing/balance.json

5、Interface response

The return value is as follows：

{"balance":0.00}

1、 Describe

Domain name audit query

2、Parameter Top

Name	Data Type	Required / Optional	Describe
order-id	Integer	Must fill	Order ID

3、HTTP mode

POST

4、Test URL request example

/api/domains/query-domain-real-name?order-id=12345678

5、Interface response

The return value is as follows：

{status:"pass"}

1、 Describe

Modify the DNS server of the subdomain under the domain name to support IPv6

2、Parameter Top

Name	Data Type	Required / Optional	Describe
auth-userid	String	Must fill	Authentication parameters Agent ID
api-key	String	Must fill	Authentication Parameter API KEY
orderid	Integer	Must fill	Domain ID
host	String	Must fill	Subdomain
ips	String	Must fill	IPv4 or IPv6 (multiple)

3、HTTP mode

GET

4、Test URL request example

/api/domains/updateNS.json?auth-userid=0&api-key=key&orderid=113502496&host=abc&newips=6.6.6.6&newips=7.7.7.7

5、Interface response

The return value is as follows：

Return json string
Successful operation:
success: true
operation failed:
success: false or status: ERROR
Prompt information
message: information

1、Describe

Modify the DNS server of the subdomain name under the domain name to support IPv6, the original DNS server will be all deleted

2、Parameter Top

Name	Data Type	Required / Optional	Describe
auth-userid	Integer	Must fill	Authentication parameters Agent ID
api-key	String	Must fill	Authentication Parameter API KEY
orderid	Integer	Must fill	DomainID
host	String	Must fill	Subdomain
newips	String	Must fill	New IP, IPv4 or IPv6 (multiple possible)

3、HTTP mode

GET

4、Test URL request example

/api/domains/updateNS.json?auth-userid=0&api-key=key&orderid=113502496&host=abc&newips=6.6.6.6&newips=7.7.7.7

5、Interface response

The return value is as follows：

Return json string
Successful operation:
success: true
operation failed:
success: false or status: ERROR
Prompt information
message: information

1、Describe

Delete all DNS servers of subdomains under the domain name

2、Parameter Top

Name	Data Type	Required / Optional	Describe
auth-userid	Integer	Must fill	Authentication parameters Agent ID
api-key	String	Must fill	Authentication Parameter API KEY
orderid	Integer	Must fill	Domain ID
host	String	Must fill	Subdomain

3、HTTP mode

GET、POST

4、Test URL request example

/api/domains/deleteNS.json?auth-userid=0&api-key=key&order-id=113502496&host=abc

5、Interface response

The return value is as follows：

Return json string
Successful operation:
success: true
operation failed:
success: false or status: ERROR
Prompt information
message: information

1、 Describe

Query the resolution list under the domain name

2、 Parameter Top

Name	Data Type	Required / Optional	Describe
auth-userid	Integer	Must fill	Authenticate Parameter Agent ID
api-key	String	Must fill	Authentication Parameter API KEY
Domain	String	Must fill	Domain name
currentPage	String	Certificate	Current page number
pageSize	String	Certificate	Maximum number of pages: 500

3、HTTP mode

GET、POST

4、 Test URL request example

/api/dns/describe-record-index.json?auth-userid=0&api-key=key&Domain=c.com

5、Interface response

The return value is as follows：

Return jsonString
Successful operation:
{"RequestId":"6fa71dfc-4d68-485a-8134-3720502b3dd4","Data":[{"id":1,"domain":"test.com","host":"s03","type":"A","value":"127.0.0.1","ttl":600,"mx":0,"state":0,"line":"","remark":null}],"Pagination":{"current":1,"pageSize":20,"total":12}}
state Describe 0: 'Normal ', 2:' Paused ',3: 'Paused by administrator ',4':' to be reviewed ',5: 'Failed',
The resolution to add URL forwarding needs to pass the audit before it can be added successfully

operation failed:
success：false or status：ERROR
Prompt information
message：information

1、 Describe

Add a single resolution for your domain name

2、 Parameter Top

Name	Data Type	Required / Optional	Describe
auth-userid	Integer	Must fill	Authenticate Parameter Agent ID
api-key	String	Must fill	Authentication Parameter API KEY
Domain	String	Must fill	Domain name
Host	String	Certificate	Host header, not filled in the default @
Type	String	Certificate	Host type, default is A, allowed values: "A", "CNAME", "TXT", "MX", "SRV", "CAA", "REDIRECT_URL", "FORWARD_URL"
Value	String	Must fill	Host value
Mx	String	Must fill	MX record priority value range: [1,50]
Ttl	String	Must fill	ttl, the minimum shall not be less than 600

3、HTTP mode

GET、POST

4、 Test URL request example

/api/dns/add-domain-record.json?auth-userid=0&api-key=key&Domain=1&Host=s04&Mx=&Ttl=600&Type=A&Value=127.0.0.2

5、Interface response

The return value is as follows：

Return jsonString
Successful operation:
{"RequestId":"78664721-6fb4-4dc6-90fa-2e25646b897b","Id":9919432}
operation failed:
success：false or status：ERROR
Prompt information
message：information

1、 Describe

Modify the resolution under your domain name

2、 Parameter Top

Name	Data Type	Required / Optional	Describe
auth-userid	Integer	Must fill	Authenticate Parameter Agent ID
api-key	String	Must fill	Authentication Parameter API KEY
Id	String	Must fill	Parse record ID
Host	String	Certificate	Host header, not filled in the default @
Type	String	Certificate	Host type, default is A, allowed values: "A", "CNAME", "TXT", "MX", "SRV", "CAA", "REDIRECT_URL", "FORWARD_URL"
Value	String	Must fill	Host value
Mx	String	Must fill	MX record priority value range:[1,50]
Ttl	String	Must fill	ttl, the minimum shall not be less than 600

3、HTTP mode

GET、POST

4、 Test URL request example

/api/dns/update-domain-record.json?auth-userid=0&api-key=key&Id=1&Host=s04&Mx=&Ttl=600&Type=A&Value=127.0.0.2

5、Interface response

The return value is as follows：

Return jsonString
Successful operation:
{"RequestId":"78664721-6fb4-4dc6-90fa-2e25646b897b"}
operation failed:
success：false or status：ERROR
Prompt information
message：information

1、 Describe

Removes a single resolution under the Domain name

2、 Parameter Top

Name	Data Type	Required / Optional	Describe
auth-userid	Integer	Must fill	Authenticate Parameter Agent ID
api-key	String	Must fill	Authentication Parameter API KEY
Id	String	Must fill	Parse record ID

3、HTTP mode

GET、POST

4、 Test URL request example

/api/dns/delete-domain-record.json?auth-userid=0&api-key=key&Id=1

5、Interface response

The return value is as follows：

Return jsonString
Successful operation:
{"RequestId":"78664721-6fb4-4dc6-90fa-2e25646b897b"}
operation failed:
success：false or status：ERROR
Prompt information
message：information

1、 Describe

Removes a single resolution under the Domain name

2、 Parameter Top

Name	Data Type	Required / Optional	Describe
auth-userid	Integer	Must fill	Authenticate Parameter Agent ID
api-key	String	Must fill	Authentication Parameter API KEY
Id	String	Must fill	Parse record ID
Status	String	Must fill	Parse the record state. Value: Enable: Disable: suspend parsing

3、HTTP mode

GET、POST

4、 Test URL request example

/api/dns/set-domain-record-status.json?auth-userid=0&api-key=key&Id=1&Status=Enable

5、Interface response

The return value is as follows：

Return jsonString
Successful operation:
{"RequestId":"78664721-6fb4-4dc6-90fa-2e25646b897b"}
operation failed:
success：false or status：ERROR
Prompt information
message：information

1、 Describe

Check Domain Price

2、 Parameter Top

Name	Data Type	Required / Optional	Describe
order-id	String	Optional	Priority: Get renewal price based on order ID
domain-name	String	Optional	If order ID does not exist, fetch registration and renewal price based on domain name
tld	String	Optional	If both order ID and domain name are unavailable, fetch registration and renewal prices based on the domain's TLD suffix
period	String	Required	-

3、HTTP mode

GET

4、 Test URL request example

/api/domains/describe-price.json?order-id=1&domain-name=laskhjdklsahdlaskd.cn&tld=cn&period=1

5、Interface response

The return value is as follows：

Return jsonString
Successful operation:
{"RequestId":"78664721-6fb4-4dc6-90fa-2e25646b897b","Data":{"Create": {"Price": 73}, "Renew": {"Price": 76}}}
operation failed:
success：false or status：ERROR
Prompt information
message：information