当前位置: 文档中心

接口规范说明


1. 通讯协议

  • REST风格的API,使用HTTP协议发送POST请求调用接口。

  • HTTP请求头类型为 Content-Type: application/x-www-form-urlencoded


2. 报文及报文编码

  • 报文为UTF8编码,支持半角、中文、英文、数字、基本标点符号,请注意不要有表情符号等各种非法字符,会导致数据库写入失败。

  • 请求报文用键值对的形式通过 & 拼接后放在body里,格式类似这样 key=1&key={“xx”:”1″}&key=[{“xx”:”1″}]形式,要用post的方式发送,不要用get拼接在url后边。

  • 为了保证传输数据的安全性,API采用了对称加密的方式,旺店通开放平台会为每个接入客户分配appkey和appsecret,通过计算sign(签名)来防止恶意的数据篡改,具体的sign计算方式请参考 sign算法” 文档

  • 编码示例:key=urlencode(value)&key=urlencode(value) urlencode() 为进行编码的方法。(每个语言的编码函数可能不同,请开发者自主选择具体的url编码方式)。

  • 注意:appsecret不要作为请求参数发送到互联网中。

  • 注意:旺店通ERP存在商品明细的单据中可以存在多行商家编码一样的商品,如果对接的系统不支持此情况,需进行合并处理。


3. 接口文档说明

3.1 接口说明

  • 用于接口描述、接口级别注意事项、敏感数据以及建议调用方式等。

3.2 调用场景

  • 用于说明接口适用对接的系统。

3.3请求参数说明

  • 描述了请求报文所有输入参数的含义及注意事项。

3.3.1 请求地址(url)

  • 接口文档该部分描述了每个接口的测试和正式环境请求地址,注:不同接口变更“接口服务名”即可。

       1)测试环境:http://sandbox.wangdian.cn/openapi2/接口服务名

       2)正式环境:http://api.wangdian.cn/openapi2/接口服务名

3.3.2 公共请求参数

  • 每个接口都必须输入的参数接口文档该部分阐述了请求报文中公共请求参数含义及注意事项,参数详见下述表格。

  • 注:appsecret作为校验数据安全使用,不要将它作为公共参数传输到互联网中。

名称字段类型长度
必须描述
卖家账号sidString
购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。
接口账号appkeyString
本开放平台“自助对接”功能模块内自助申请,申请流程单击这里
时间戳timestampint
北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。
签名signString
API输入参数签名结果,签名算法介绍单击这里


3.3.3 业务请求参数

  • 可根据业务不同,选择输入的参数。接口文档该部分阐述了请求报文中业务请求参数含义及注意事项。

4 .1响应参数

  • 接口文档该部分描述了所有响应参数的含义及注意事项

  1)公共响应参数

  • 接口文档该部分描述了,请求的当前接口,不论请求失败还是成功,一定会返回的参数,文档该部分描述了公共响应参数的含义。

  2)业务响应参数

  • 根据请求的参数输入值不同,做不同响应的参数,文档该部分描述了业务响应参数的含义

3.3.5 请求示例

  • 调用接口的请求示例,有PHP、JAVA、C#三种示例。

3.3.6 响应示例

  • 调用接口后返回的json格式数据 ,需要使用json解析函数进行解析,使用Unicode转换具体的字段含义解释,并且给出了正常响应和异常响应两种响应示例。


4. 接口流量及调用频率限制

 4.1 流量限制

  • 限制规则:100万次/日

  • 涉及接口:所有接口

 4.2 频率限制

  • 限制规则:

         ①仅限制并发量:并发量是指调用开放平台API接口允许同时请求的线程个数。

         ②同时限制并发量和调用频率:调用频率旺店通企业版开放平台的定义为每分钟允许请求的次数。

  • 限制说明详情如下

基础类

接口服务名接口名并发量&频率/min
shop.php查询店铺3 & 60次/min
warehouse_query.php查询仓库3 & 60次/min
logistics.php查询物流3 & 60次/min
purchase_provider_query.php查询供应商3 & 60次/min
purchase_provider_create.php创建供应商3 & 60次/min

货品类

接口服务名接口名并发量&频率/min
goods_push.php创建货品档案3 & 60次/min
goods_query.php查询货品档案3 & 60次/min
api_goodsspec_push.php创建平台货品3 & 60次/min
suites_query.php查询组合装货品3 & 60次/min

订单类

接口服务名接口名并发量&频率/min
trade_push.php创建原始订单3 & 无限制
trade_query.php查询订单管理3 & 无限制
stockout_order_query_trade.php查询销售出库单3 & 无限制
logistics_sync_query.php查询物流同步3 & 60次/min
logistics_sync_ack.php物流同步回写3 & 60次/min
api_goods_stock_change_query.php查询库存同步3 & 60次/min
api_goods_stock_change_ack.php库存同步回写3 & 60次/min
stat_sales_by_spec_shop_warehouse_query.php查询销售汇总3 & 60次/min
stockout_sales_weight_push.php重量回传3 & 60次/min
trade_modify.php修改订单标记3 & 60次/min

售后类

接口服务名接口名并发量&频率/min
sales_refund_push.php创建原始退款单3 & 60次/min
stockin_refund_push.php创建退货入库单3 & 60次/min
refund_query.php查询退换管理3 & 60次/min
stockin_order_query_refund.php查询退货入库单3 & 60次/min
stat_refund_by_spec_shop_warehouse_query.php查询销售退货汇总

采购类

接口服务名接口名并发量&频率/min
purchase_order_push.php创建采购单3 & 60次/min
stockin_purchase_push.php创建采购入库单3 & 60次/min
purchase_order_query.php查询采购单管理3 & 60次/min
stockin_order_query_purchase.php查询采购入库单3 & 60次/min
purchase_return_push.php创建采购退货单3 & 60次/min
purchase_return_order_push.php创建采购退货出库单3 & 60次/min
purchase_return_query.php查询采购退货单3 & 60次/min
stockout_order_query_return.php查询采购退货出库单3 & 60次/min

库存类

接口服务名接口名并发量&频率/min
stock_query.php增量查询库存3 & 无
stock_sync_by_pd.php创建盘点单3 & 60次/min
stock_pd_order_query.php查询盘点单3 & 60次/min
stockin_order_push.php创建其他入库单3 & 60次/min
stockin_order_query.php查询入库单管理3 & 60次/min
stockout_order_push.php创建其他出库单3 & 60次/min
stockout_order_query.php查询出库单管理3 & 60次/min
stock_transfer_push.php创建调拨单3 & 60次/min
stockout_transfer_push.php创建调拨出库单3 & 60次/min
stockin_transfer_push.php创建调拨入库单3 & 60次/min
stock_transfer_query.php查询调拨单3 & 60次/min
stock_query_all.php全量查询库存3 & 60次/min
wms_stockinout_order_push.php创建委外出入库单3 & 60次/min
stock_outside_wms_query.php查询委外出入库单3 & 60次/min
jit_return_stockin_order_query.php查询JIT退货入库单3 & 60次/min
jit_stockout_order_query.php查询JIT出库单3 & 60次/min