首頁 > API文檔 > 單號識別API
單號識別API為用戶提供單號識別快遞公司服務,依托于快遞鳥大數據平臺,用戶提供快遞單號,即可實時返回可能的一個或多個快遞公司,存在多個快遞公司結果的,大數據平臺根據可能性、單號量,進行智能排序。
(1)PC端、移動端應用或網站應用集成運單物流信息查詢功能時,只需要錄入單號即可完成查詢,無需用戶輸入快遞公司。
(2)電商網站要在快遞鳥查詢或者訂閱運單時,可通過單號識別先行判斷物流公司后,再訂閱到快遞鳥。
一、接口描述/說明
(1)該接口僅對運單號做出識別,識別可能屬于的一家或多家快遞公司。
(2)接口并不返回物流軌跡,用戶可結合即時查詢接口和訂閱查詢接口完成軌跡查詢、訂閱的動作。
(3)接口識別會返回一家或者多家快遞公司,返回的數據根據快遞鳥大數據分析結果排序,排名靠前的命中率更高。
(4)若識別失敗,快遞鳥返回的匹配結果為空。
(5)接口支持的消息接收方式為HTTP POST,請求方法的編碼格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(6)接口地址:
API測試地址:http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
API正式地址:https://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx
請求系統級參數說明:
參數名稱 | 類型 | 說明 | 必須要求 |
---|
RequestData | String | 請求內容需進行URL(utf-8)編碼。請求內容JSON格式,須和DataType一致。 | 是 |
EBusinessID | String | 商戶ID,請在我的服務頁面查看。 | 是 |
RequestType | String | 請求指令類型:2002 | 是 |
DataSign | String | 數據內容簽名:把(請求內容(未編碼)+AppKey)進行MD5加密,然后Base64編碼,最后
進行URL(utf-8)編碼。詳細過程請查看Demo。 | 是 |
DataType | String | 請求、返回數據類型:只支持JSON格式 | 是 |
二、接口參數
請求內容字段定義:
參數名稱 | 類型 | 說明 | 是否必須 |
---|
LogisticCode | String | 物流單號 | 是 |
返回參數定義:
參數名稱 | 類型 | 說明 | 必須要求 |
---|
EBusinessID | String | 電商用戶ID | 是 |
LogisticCode | String | 物流單號 | 是 |
Success | Bool | 成功與否 | 是 |
Code | Int | 失敗原因 | 否 |
Shipper | ShipperCode | String | 快遞公司編碼 | 否 |
ShipperName | String | 快遞公司名稱 | 否 |
三、示例
{
"LogisticCode": "3967950525457"
}
{
"EBusinessID": "1257021",
"Success": true,
"LogisticCode": "3967950525457",
"Shippers": [
{
"ShipperCode": "YD",
"ShipperName": "韻達快遞"
}
]
}