平台接入指南-接入说明
1、平台接入一般流程:
接入流程主要可参照API接口文档:http://polyapi.com/Api/Index
以电商平台抓单接口为例,打开API文档,选择API接口说明——电商平台——电商平台订单查询,如下图:
由于调用京东平台API,只能在京东云上,所以目前调用京东平台的接口与其他平台的地址不同,京东平台接口地址为:
http://103.235.246.40/OpenAPI/do,其他平台接口地址均为:http://114.55.16.82/OpenAPI/do
调用菠萝派通用接口时,需要将公共请求参数以post传值形式传到请求地址,参数说明如下:
method 方法名称,API文档中,选择不同的接口,method的示例值会不同,当前接口的示例值即为当前接口对应的method,例如,抓单接口的method值即为Differ.JH.Business.GetOrder
appkey 用户申请应用得到的key,获得过程参考平台接入指南-账号注册
token 用户申请店铺获得的令牌,获得过程参考平台接入指南-账号注册
platid 平台编号,API文档中有各平台对应编号的详细说明
version 版本号,目前固定1.0
contenttype 返回格式,目前支持json和xml,推荐用json,注意这个是返回的数据的格式,请求参数目前传参时业务参数只支持传json格式。
bizcontent 业务参数,是API文档中业务参数的json格式字符串,例如抓单的业务参数可能如下所示:
{
"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 验证签名。详情可参考http://polyapi.com/Help/PlatDesc/sign
2、平台接入注意事项:
公共参数与私有参数
菠萝派将大部分平台都需要用的参数抽象出来,作为公共参数,一般平台只需要传公共参数即可正常调用。但部分平台根据业务需要会有自己独有的私有参数,在API文档中,将私有参数根据平台列举了出来,可以通过点击私有参数中的不同平台的链接获得当前平台的独有参数。例如,抓单私有参数选择淘宝,则可以显示淘宝的私有参数identity(查询者身份
平台专有枚举值
参数中的枚举值通常会抽象出公共的一套枚举值,可以满足大部分平台的业务需要,比如抓单接口的orderstatus(订单状态),抽象出了等待买家付款=JH_01,等待卖家发货=JH_02,等待买家确认收货=JH_03,交易成功=JH_04,交易关闭=JH_05,已暂停=JH_06,已锁定=JH_07,卖家部分发货=JH_08,订单冻结=JH_09,缺货订单=JH_10,退货订单=JH_11,投诉订单=JH_12,其他=JH_98,所有订单=JH_99这些状态的值,但是,部分平台可能订单状态较为特殊,在公共订单状态枚举中没有包含,这个时候,如果需要使用这些状态的话,可以在文档中,在业务参数orderstatus的描述中,通过点击下图所示+..符号,查看订单状态的详情:
同时,也可以在代码中,通过请求获取平台字典数据接口,获得相应字典数据