注冊
控制中心
代理账号:{{userInfo.UserId}}
{{userInfo.Level}}
可用余额:{{userInfo.AvailableDeposit}}元
退出登录
HTTP API接口模式
接口模式系統是時代互聯專門為從事互聯網基礎產品提供,有自己的業務平台的代理商量身訂做的一套業務系統以自己的站點。
立即註冊试用
HTTP API接口模式
立即註冊试用
入口及檢驗
1.URL
HTTP API 地址是 :http://api.eranet.com:2080/
2.驗證
所有發送的請求都需要如下驗證參數:
auth-userid: 您當前的代理商賬号 ID(查詢您的代理 ID)
api-key: 一串用于認證 API 命令調用字母數字代碼(閱讀如下提示,查詢您的 API Key)
注: auth-userid和api-key全部用get請求方式,接口業務參數請參見接口HTTP方式要求。
3.找到您的代理商ID,API Key,和授權IP
(1)、登錄您的代理商控制面闆:
(2)、在左側功能欄最上方代理号碼:****寫的一般是六到七位數字就是代理ID
(3)、在左側功能欄找到“HTTP API接口管理”下面的“修改重置API KEY”,可以初使化生成API驗證密碼也就是API KEY,也可以在同一頁面修改API密碼
(4)、在左側功能欄找到“HTTP API接口管理”下面的"更改接口驗證IP”,可以授權您要調用 接口的服務器IP進行授權,沒有授權将無法使用接口
注意
重新生成一個新的 API Key 意味着您舊的 API Key 馬上失效,這将會對您的現有 API驗證失敗
4.API
HTTP API 要求所有用于檢索數據的請求應使用 GET 方法而提交,更改以及删除數據的請求應使用 POST方法。如果您沒有使用正确的方法發送請求,那麽特殊 HTTP 方法的請求則會返回錯誤值。然而,爲了使您能夠更簡便地用浏覽器及命令行工具測試 API,我們提供了測試 URL,讓您能夠使用 GET
域名查询
1.描述
查詢某一特定域名是否可注冊
2.參數
名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 Authentication Parameter 認證參數 API KEY
domain-name 字符串數組 必填 需要查詢的域名
tlds 字符串數組 必填 待查詢域名的頂級域後綴
3.HTTP 方式
GET方式
4.測試 URL 請求範例
/api/domains/available.json?auth-userid=0&api-key=key&domain-name=domain1&domain-name=domain2&tlds=com&tlds=net
5.接口返回值
返回一個 hash Map,其中包含所查詢的頂級域名後綴的 availability status:
域名查詢狀态(status)
available -域名可以注冊
unavailable-域名已經被注冊
建立聯系人模版
1.描述
利用提供的詳細信息給域名添加聯系人
2.參數
名稱 數據類型 必填/可選 描述
3.HTTP 方式
POST
URL 請求範例
/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.接口返回值
返回新添加的聯系人的 Contact Id (整數值) 。不同類型的聯系人可以使用相同的名稱和公司名稱
URL 請求範例
/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.接口響應
返回新添加的聯系人的聯系人ID(Integer)
如遇到錯誤,會返回包含 ERROR和錯誤信息的狀态值
Register 域名注冊
1.描述
查詢某一特定域名是否可注冊
2.參數
名稱 數據類型 必填/可選 描述
3.HTTP 方式
POST
4.測試 URL 請求範例
/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.接口響應
返回值如下:
域名注冊訂單 ID (entityid):
域名服務器修改操作描述 (actiontypedesc)
域名服務器修改狀态 (actionstatus)
域名服務器修改狀态描述(actionstatusdesc)
如出現任何錯誤,狀态會返回值爲 Error 并附帶一條錯誤信息
獲取域名ID
1.描述
獲取已注冊域名的ID
2.參數
名稱 數據類型 必填/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 認證參數 API KEY
domain-name 字符串 必填 想要獲取 ID 的已注冊域名
3.HTTP 方式
GET
4.測試 URL 請求範例
/api/domains/orderid.json?auth-userid=0&api-key=key&domain-name=domain.com
5.接口響應
返回已注冊域名對應的ID(整數)
通過域名ID獲取域名註冊信息
1.描述
通過特定的域名 ID 獲取相關的 域名注冊訂單信息
2.參數
名稱 數據類型 必填/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 認證參數 API KEY
order-id 整數 必填 需要獲取信息的 域名注冊訂單的 ID
options 字符串數組 必填 值可設置爲:All
3.HTTP 方式
GET
4.測試 URL 請求範例
/api/domains/details.json?auth-userid=0&api-key=key&order-id=0&options=All
5.接口響應
返回一個 hash map 包含域名注冊訂單的信息:
域名 ID (entityid)
域名 (domainname)
訂單描述 (description)
目前的訂單狀态(currentstatus) (暫時未啓用忽略)
域名狀态(orderstatus)
訂單生成日期(以注冊局時間爲準)(creationtime)
過期日期(以注冊局時間爲準) (endtime)
該訂單是否隻屬于代理商賬戶下的某一客戶 (isImmediateReseller) (暫時未啓用忽略)
注冊聯系人 ID (registrantcontactid)
管理聯系人 ID(admincontactid)
技術聯系人 ID (techcontactid)
賬單聯系人 ID (billingcontactid)
域名服務器(ns1 and ns2)
域名續費
1.描述
對于特定的 域名訂單進行特定年數的續費操作
2. 參數
名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 認證參數 API KEY
order-id 整數 必填 您想要續費的 域名訂單号
years 整數 必填 您想要對該域名續費的年數
exp-date 整數 必填 訂單現在的過期日,用 epoch time 格式
3. HTTP 方式
POST
4.測試 URL 請求範例
/api/domains/renew.json?auth-userid=0&api-key=key&order-id=562994&years=1&exp-date=1279012036
5.接口響應
返回值如下:
域名注冊訂單 ID (entityid)
域名服務器修改操作描述 (actiontypedesc)
域名服務器修改狀态 (actionstatus)
域名服務器修改狀态描述(actionstatusdesc)
如出現任何錯誤,狀态會返回值爲 Error 并附帶一條錯誤信息
修改域名 DNS 服務器
1.描述
修改指定 域名訂單的域名 dns 服務器
2.參數
名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 認證參數 API KEY
order-id 整數 必填 需要獲取信息的 域名注冊訂單的 ID
ns 字符串數組 必填 新的域名 dns 服務器
3.HTTP 方式
POST
4.測試 URL 請求範例
/api/domains/modify-ns.json?auth-userid=0&api-key=key&order-id=0&ns=ns1.domain.asia&ns=ns2.domain.asia
5、接口響應
返回值如下:
修改狀态(actionstatus)
修改狀态描述 (actiontypedesc)
域名注冊訂單的 ID(entityid)
是否成功(success)
如出現任何錯誤,狀态會返回值爲 Error 并附帶一條錯誤信息
域名過戶(修改聯系人)
1.描述
修改特定域名訂單的聯系人信息
2.參數
名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 認證參數 API KEY
order-id 整數 必填 需要獲取信息的 域名注冊訂單的 ID
>reg-contact-id 整數 必填 新注冊聯系人 ID
admin-contact-id 整數 必填 新注冊聯系人 ID
tech-contact-id 整數 必填 新技術聯系人 ID
billing-contact-id 整數 必填 新賬單聯系人 ID
3.HTTP 方式
POST
4.測試 URL 請求範例
/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.接口響應
返回值如下:
域名注冊訂單 ID (entityid)
域名服務器修改操作描述 (actiontypedesc)
域名服務器修改狀态 (actionstatus)
域名服務器修改狀态描述(actionstatusdesc)
如出現任何錯誤,狀态會返回值爲 Error 并附帶一條錯誤信息
Transfer 轉入和提交密碼
一、Transfer 轉入
1.描述
轉移域名
注意
您必須确保域名已經解鎖。
2.參數
名稱 數據類型 必選/可選 描述
{{item.name}} {{item.type}} {{item.select}} {{item.message}}
3.HTTP 方式
POST
4.測試 URL 請求範例
/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.接口響應
返回值如下:
域名提交轉入狀态 (status)
返回信息 (message)
如出現任何錯誤,狀态會返回值爲 Error 并附帶一條錯誤信息
二、提交域名轉移密碼
1.描述
爲正在轉入時代互聯的域名提交域名轉移碼(也稱之爲授權碼)
注意
您必須确保域名已經解鎖。
2.參數
名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 認證參數 API KEY
order-id 整數 必填 轉入域名的訂單 ID
auth-code 字符串 必填 轉入域名的轉移碼或授權碼
3.HTTP 方式
GET
4.測試 URL 請求範例
/api/domains/transfer/submit-auth-code.xml?auth-userid=0&api-key=0&order-id=12345678&auth-code=authcodegoeshere
5.接口響應
如提供的授權碼爲正确的,将返回值 success(字符串),域名轉入進程将會繼續。如出現任何錯誤信息,将會返回狀态值爲 Error,和具體的錯誤信息
轉移結果查詢
1.描述
查詢域名轉移結果
2.參數
名稱 數據類型 必選/可選 描述
order-id 整數 必填 訂單id
3.HTTP 方式
POST
4.測試 URL 請求範例
/api/domains/query-transfer?order-id=12345678
5.接口響應
返回值如下:
{"trStatus":"pending"}
實名認證提交
1.描述
實名認證提交接口可支持需要實名認證域名提交實名
2.參數
名稱 數據類型 必選/可選 描述
tld 字符串 必填 待查詢域名的頂級域後綴 (例如:cn com cc等暫時隻支持cn与hk)
contact-id 整數 必填 已經建立好的需提交實名認證的聯繫人id
ident-type 字符串 必填 證件類型(hk 仅支持 SFZ / HZ / HKID / YYZZ / ORG / HKBR / QT)查看詳情
ident-no 字符串 必填 證件號碼
ident-image-base64 字符串 必填 採用Base64編碼的實名認證資料圖片(base64編碼後要小於於200KB 否則會返回413 Request Entity Too Large)
ident-ext-image-base64 字符串 非必填 採用Base64編碼的實海外自然人承諾書(下載),隻有所有者為非中國國內個人所有者時才需要提交
3.HTTP 方式
POST
4.測試 URL 請求範例
/api/contacts/real-name-submit.json?tld=com&contact-id=12345678&ident-type=JGZ&ident-no=11111&ident-image-base64=4541564646
5.接口響應
返回值如下:
聯系人 ID (entityid)
提交域名後綴 (tld)
實名提交狀态 (status)
實名結果查詢
1.描述
實名結果查詢
2.參數
名稱 數據類型 必選/可選 描述
tld 字符串 必填 待查詢域名的頂級域後綴 (例如:cn com cc等暫時隻支持cn)
contact-id 整數 必填 已經建立好的需提交實名認證的聯繫人id
3.HTTP 方式
POST
4.測試 URL 請求範例
/api/contacts/real-name-query.json?tld=com&contact-id=12345678
5.接口響應
返回值如下:
聯系人 ID (entityid)
域名後綴 (tld)
實名狀态 (status)
hk域名的模板此处会返回 none 和 uploaded
查詢代理商餘額
1.描述
查詢代理商餘額
2.參數
名稱 數據類型 必選/可選 描述
username 字符串 必填 用戶名
password 字符串 必填 密碼
3.HTTP 方式
GET
4.測試 URL 請求範例
/api/billing/balance.json
5.接口響應
返回值如下:
{"balance":0.00}
域名命名審核查詢(暫時隻支持cn)
1.描述
域名命名審核查詢
2.參數
名稱 數據類型 必選/可選 描述
order-id 整數 必填 訂單id
3.HTTP 方式
POST
4.測試 URL 請求範例
/api/domains/query-domain-real-name?order-id=12345678
5.接口響應
返回值如下:
{status:"pass"}
添加域名NS
1.描述
給所屬域名下的子域名登記DNS服務器,支持IPv6
2.參數
名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 Authentication Parameter 認證參數 API KEY
orderid 整數 必填 域名ID
host 字符串 必填 子域名
ips 字符串 必填 IPv4或IPv6(可多個)
3.HTTP 方式
GET
4.測試 URL 請求範例
/api/domains/createNS.json?auth-userid=0&api-key=key&orderid=113502496&host=abc&ips=8.8.8.8&ips=9.9.9.9
5.接口響應
返回值如下:
返回json字符串
操作成功:
success:true
操作失敗:
success:false 或 status:ERROR
提示信息
message:信息
修改域名NS
1.描述
修改所屬域名下子域名的DNS服務器,支持IPv6,原DNS服務器将被全部删除
2.參數
名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 Authentication Parameter 認證參數 API KEY
orderid 整數 必填 域名ID
host 字符串 必填 子域名
newips 字符串 必填 新IP,IPv4或IPv6(可多個)
3.HTTP 方式
GET
4.測試 URL 請求範例
/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.接口響應
返回值如下:
返回json字符串
操作成功:
success:true
操作失敗:
success:false 或 status:ERROR
提示信息
message:信息
删除域名NS
1.描述
删除所屬域名下子域名的全部DNS服務器
2.參數
名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 Authentication Parameter 認證參數 API KEY
orderid 整數 必填 域名ID
host 字符串 必填 子域名
3.HTTP 方式
GET、POST
4.測試 URL 請求範例
/api/domains/deleteNS.json?auth-userid=0&api-key=key&order-id=113502496&host=abc
5.接口響應
返回值如下:
返回json字符串
操作成功:
success:true
操作失敗:
success:false 或 status:ERROR
提示信息
message:信息
查詢解析
1.描述
查詢域名下的解析列表
2.參數
名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 Authentication Parameter 認證參數 API KEY
Domain 字符串 必填 域名
currentPage 字符串 選填 當前頁碼
pageSize 字符串 選填 每頁數量 最大500
3.HTTP 方式
GET、POST
4.測試 URL 請求範例
/api/dns/describe-record-index.json?auth-userid=0&api-key=key&Domain=c.com
5.接口響應
返回值如下:
返回json字符串
操作成功:
{"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描述 0: '正常', 2: '暫停',3: '管理員暫停',4': '待審核',5: '不通過',
添加URL轉發的解析需要通過審核才可添加成功
操作失敗:
success:false 或 status:ERROR
提示信息
message:信息
添加解析
1.描述
添加所屬域名的單條解析
2.參數
名稱 數據類型 必選/可選 描述
{{item.name}} {{item.type}} {{item.select}} {{item.message}}
3.HTTP 方式
GET、POST
4.測試 URL 請求範例
/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.接口響應
返回值如下:
返回json字符串
操作成功:
{"RequestId":"78664721-6fb4-4dc6-90fa-2e25646b897b","Id":9919432}
操作失敗:
success:false 或 status:ERROR
提示信息
message:信息
修改解析
1.描述
修改所屬域名下的解析
2.參數
名稱 數據類型 必選/可選 描述
{{item.name}} {{item.type}} {{item.select}} {{item.message}}
3.HTTP 方式
GET、POST
4.測試 URL 請求範例
/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.接口響應
返回值如下:
返回json字符串
操作成功:
{"RequestId":"78664721-6fb4-4dc6-90fa-2e25646b897b"}
操作失敗:
success:false 或 status:ERROR
提示信息
message:信息
删除解析
1.描述
删除所屬域名下的單條解析
2.參數
名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 Authentication Parameter 認證參數 API KEY
Id 字符串 必填 解析記錄ID
3.HTTP 方式
GET、POST
4.測試 URL 請求範例
/api/dns/delete-domain-record.json?auth-userid=0&api-key=key&Id=1
5.接口響應
返回值如下:
返回json字符串
操作成功:
{"RequestId":"78664721-6fb4-4dc6-90fa-2e25646b897b"}
操作失敗:
success:false 或 status:ERROR
提示信息
message:信息
開啓暫停解析記錄
1.描述
删除所屬域名下的單條解析
2.參數
名稱 數據類型 必選/可選 描述
auth-userid 整數 必填 認證參數 代理商 ID
api-key 字符串 必填 Authentication Parameter 認證參數 API KEY
Id 字符串 必填 解析記錄ID
Status 字符串 必填 解析記錄狀态。取值:Enable: 啓用解析 Disable: 暫停解析
3.HTTP 方式
GET、POST
4.測試 URL 請求範例
/api/dns/set-domain-record-status.json?auth-userid=0&api-key=key&Id=1&Status=Enable
5.接口響應
返回值如下:
返回json字符串
操作成功:
{"RequestId":"78664721-6fb4-4dc6-90fa-2e25646b897b"}
操作失敗:
success:false 或 status:ERROR
提示信息
message:信息
域名詢價
1.描述
查詢域名價格
2.參數
名稱 數據類型 必選/可選 描述
order-id 字符串 可選 优先取order-id获取续费价格
domain-name 字符串 可選 如order-id不存在则取domain-name,根据域名获取注册和续费价格
tld 字符串 可選 如order-id和domain-name不存在则取tld后缀,根据域名获取注册和续费价格
period 字符串 必填 -
3.HTTP 方式
GET
4.測試 URL 請求範例
/api/domains/describe-price.json?order-id=1&domain-name=laskhjdklsahdlaskd.cn&tld=cn&period=1
5.接口響應
返回值如下:
返回json字符串
操作成功:
{"RequestId":"78664721-6fb4-4dc6-90fa-2e25646b897b","Data":{"Create": {"Price": 73}, "Renew": {"Price": 76}}}
操作失敗:
success:false 或 status:ERROR
提示信息
message:信息
模板郵箱認證
1.描述
模板郵箱認證
2.參數
名稱 數據類型 必選/可選 描述
contact-id 字符串 必選 模板ID
3.HTTP 方式
GET
4.測試 URL 請求範例
/api/contacts/email-auth.json?contact-id=1
5.接口響應
返回值如下:
返回json字符串
操作成功:
{"RequestId":"78664721-6fb4-4dc6-90fa-2e25646b897b"}
操作失敗:
提示信息
message:信息