詳細說明及接口權限申請:點擊進入官網申請
1、接口說明
如果傳入的數據是 IP 地址,那麼直接返回 IP 地址對應的省(市/自治區)、市(區/自治州)、區(縣/市/區)以及運營商名稱;如果傳入的數據是域名,則先解析出域名對應的 IP 地址,再返回 IP 地址對應的省(市/自治區)、市(區/自治州)、區(縣/市/區)以及運營商名稱。
2、接口描述
2.1、功能描述
獲取 IP 地址對應的省(市/自治區)、市(區/自治州)、區(縣/市/區)以及運營商名稱;或者查詢域名解析到的 IP 地址對應的省(市/自治區)、市(區/自治州)、區(縣/市/區)以及運營商名稱。
2.2、URL 示例
1)http 協議:
POST 方式請求:
http://cha.ebaitian.cn/api/json?appid=xxx&module=getIPAddressInfo&ip=xxx&sign=xxx
GET 方式請求:
http://cha.ebaitian.cn/api/json?type=get&appid=xxx&module=getIPAddressInfo&ip=xxx&sign=xxx
2)https 協議:
POST 方式請求:
https://cha.ebaitian.cn/api/json?appid=xxx&module=getIPAddressInfo&ip=xxx&sign=xxx
GET 方式請求:
https://cha.ebaitian.cn/api/json?type=get&appid=xxx&module=getIPAddressInfo&ip=xxx&sign=xxx
3、請求參數
3.1、數據包體
{
"type": "get",
"appid": "1000xxxx",
"module": "getIPAddressInfo",
"ip": "127.0.0.1",
"sign": "ecab4881ee80ad3d76bb1da68387428ca752eb885e52621a3129dcf4d9bc4fd4"
}
3.2、參數說明
參數 | 必選 | 類型 | 描述 |
---|---|---|---|
type | 否 | string | 授權接口的請求方式 |
appid | 是 | string | 授權接口的 AppID,請填寫您在我要查官網上申請到的 AppID |
module | 是 | string | 目標請求的數據模塊,查詢IP地址/域名信息爲:getIPAddressInfo |
ip | 是 | string | 目標要查詢的IP地址,也可以是一個標準格式的域名,如:woyaocha.net |
sign | 是 | string | 請求憑證,具體計算方式見下面的其他說明 |
3.3、其他說明
1)type:可選值 get,如果賦值 get,則以 get 方式提交數據;默認以 post 方式提交數據;
2)sign:簽名校驗,根據公式$sign=sha256(appid=$appid&module=getIPAddressInfo&ip=$ip&appkey=$appkey)
生成;其中:appkey 爲授權接口的 AppKey,請填寫您在我要查官網上申請到的 AppKey 。點擊鏈接申請:https://console.ebaitian.cn/control/api_mng/api_idx.html
構造僞代碼如下:
string type = "get"; //請求方式,可以賦值爲:post
string appid = "1000xxxx"; //sdkappid 對應的 appid,需要業務方高度保密
string module = "getIPAddressInfo"; //請求的數據模塊,此處賦值:getIPAddressInfo
string ip = "127.0.0.1"; //要查詢的IP地址,也可以是一個標準格式的域名
string sign = sha256(appid=1000xxxx&module=getIPAddressInfo&ip=127.0.0.1&appkey=56cf61af4b7897e704f67deb88ae8f24);
4、響應參數
4.1、數據包體
{
"result":1,
"description":"TRUE",
"flag":"",
"ipInfo":{
"address":"湖北省武漢市",
"isp":"電信DNS服務器",
"notes":""
}
}
4.2、參數說明
參數 | 必選 | 類型 | 描述 |
---|---|---|---|
result | 是 | string | 接口響應結果:0-失敗;1成功 |
description | 是 | string | 接口響應描述:一般爲 TURE(result=1) 與 FALSE(result=0),或者返回錯誤信息 |
flag | 否 | string | 錯誤說明,沒有錯誤則返回空 |
ipInfo | 是 | object | 返回IP地址信息,或域名對應的IP地址信息 |
ipInfo 參數說明:
參數 | 必選 | 類型 | 描述 |
---|---|---|---|
address | 是 | string | 地區信息,即 IP 地址對應的省(市/自治區)、市(區/自治州)、區(縣/市/區) |
isp | 是 | string | ISP 運營商或使用單位 |
notes | 否 | string | 其他備註信息,一般爲空 |