平臺接入指南-接入說明
1、平臺接入一般流程:
接入流程主要可參照API接口文檔:http://polyapi.com/Api/Index
以電商平臺抓單接口為例,打開API文檔,選擇API接口說明——電商平臺——電商平臺訂單查詢,如下圖:
由于調(diào)用京東平臺API,只能在京東云上,所以目前調(diào)用京東平臺的接口與其他平臺的地址不同,京東平臺接口地址為:
http://103.235.246.40/OpenAPI/do,其他平臺接口地址均為:http://114.55.16.82/OpenAPI/do
調(diào)用菠蘿派通用接口時(shí),需要將公共請求參數(shù)以post傳值形式傳到請求地址,參數(shù)說明如下:
method 方法名稱,API文檔中,選擇不同的接口,method的示例值會不同,當(dāng)前接口的示例值即為當(dāng)前接口對應(yīng)的method,例如,抓單接口的method值即為Differ.JH.Business.GetOrder
appkey 用戶申請應(yīng)用得到的key,獲得過程參考平臺接入指南-賬號注冊
token 用戶申請店鋪獲得的令牌,獲得過程參考平臺接入指南-賬號注冊
platid 平臺編號,API文檔中有各平臺對應(yīng)編號的詳細(xì)說明
version 版本號,目前固定1.0
contenttype 返回格式,目前支持json和xml,推薦用json,注意這個(gè)是返回的數(shù)據(jù)的格式,請求參數(shù)目前傳參時(shí)業(yè)務(wù)參數(shù)只支持傳json格式。
bizcontent 業(yè)務(wù)參數(shù),是API文檔中業(yè)務(wù)參數(shù)的json格式字符串,例如抓單的業(yè)務(wù)參數(shù)可能如下所示:
{
"OrderStatus":99,
"OrderNo":"317332561529457763",
"StartTime":"2016-06-03 09:12:21",
"EndTime":"2016-06-23 09:12:21",
"TimeType":3,
"PageIndex":1,
"PageSize":100,
"ShopType":"FTP"
}
sign 驗(yàn)證簽名。詳情可參考http://polyapi.com/Help/PlatDesc/sign
2、平臺接入注意事項(xiàng):
公共參數(shù)與私有參數(shù)
菠蘿派將大部分平臺都需要用的參數(shù)抽象出來,作為公共參數(shù),一般平臺只需要傳公共參數(shù)即可正常調(diào)用。但部分平臺根據(jù)業(yè)務(wù)需要會有自己獨(dú)有的私有參數(shù),在API文檔中,將私有參數(shù)根據(jù)平臺列舉了出來,可以通過點(diǎn)擊私有參數(shù)中的不同平臺的鏈接獲得當(dāng)前平臺的獨(dú)有參數(shù)。例如,抓單私有參數(shù)選擇淘寶,則可以顯示淘寶的私有參數(shù)identity(查詢者身份
平臺專有枚舉值
參數(shù)中的枚舉值通常會抽象出公共的一套枚舉值,可以滿足大部分平臺的業(yè)務(wù)需要,比如抓單接口的orderstatus(訂單狀態(tài)),抽象出了等待買家付款=JH_01,等待賣家發(fā)貨=JH_02,等待買家確認(rèn)收貨=JH_03,交易成功=JH_04,交易關(guān)閉=JH_05,已暫停=JH_06,已鎖定=JH_07,賣家部分發(fā)貨=JH_08,訂單凍結(jié)=JH_09,缺貨訂單=JH_10,退貨訂單=JH_11,投訴訂單=JH_12,其他=JH_98,所有訂單=JH_99這些狀態(tài)的值,但是,部分平臺可能訂單狀態(tài)較為特殊,在公共訂單狀態(tài)枚舉中沒有包含,這個(gè)時(shí)候,如果需要使用這些狀態(tài)的話,可以在文檔中,在業(yè)務(wù)參數(shù)orderstatus的描述中,通過點(diǎn)擊下圖所示+..符號,查看訂單狀態(tài)的詳情:
同時(shí),也可以在代碼中,通過請求獲取平臺字典數(shù)據(jù)接口,獲得相應(yīng)字典數(shù)據(jù)