接口规范说明
1. 通讯协议
REST风格的API,使用HTTPS协议发送POST请求调用接口。
HTTPS请求头类型为 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)测试环境:https://sandbox.wangdian.cn/openapi2/接口服务名
2)正式环境:https://api.wangdian.cn/openapi2/接口服务名
3.3.2 公共请求参数
每个接口都必须输入的参数。接口文档该部分阐述了请求报文中公共请求参数的含义及注意事项,参数详见下述表格。
注:appsecret作为校验数据安全使用,不要将它作为公共参数传输到互联网中。
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
卖家账号 | sid | String | 是 | 购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。 | |
接口账号 | appkey | String | 是 | 本开放平台“自助对接”功能模块内自助申请,申请流程单击这里 | |
时间戳 | timestamp | int | 是 | 北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。 | |
签名 | sign | String | 是 | API输入参数签名结果,签名算法介绍单击这里 |
3.3.3 业务请求参数
可根据业务不同,选择输入的参数。接口文档该部分阐述了请求报文中业务请求参数的含义及注意事项。
4 .1响应参数
接口文档该部分描述了所有响应参数的含义及注意事项
1)公共响应参数
接口文档该部分描述了,请求的当前接口,不论请求失败还是成功,一定会返回的参数,文档该部分描述了公共响应参数的含义。
2)业务响应参数
根据请求的参数输入值不同,做不同响应的参数,文档该部分描述了业务响应参数的含义
3.3.5 请求示例
调用接口的请求示例,有PHP、JAVA、C#三种示例。
3.3.6 响应示例
调用接口后返回的json格式数据 ,需要使用json解析函数进行解析,使用Unicode转换具体的字段含义解释,并且给出了正常响应和异常响应两种响应示例。
4.1 流量限制
限制条件:sid+appkey+接口
限制规则:100万次/日
涉及接口:所有接口
4.2 频率限制
限制条件:sid+appkey+单独接口
涉及接口:所有接口
限制规则:
①仅限制并发量:并发量是指调用开放平台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 |
api_goods_query.php | 查询平台货品 | 3 & 60次/min |
suites_query.php | 查询组合装货品 | 3 & 60次/min |
goods_brand_query.php | 查询货品品牌 | 3 & 60次/min |
goods_class_query.php | 查询货品分类 | 3 & 60次/min |
接口服务名 | 接口名 | 并发量&频率/min |
---|---|---|
trade_push.php | 创建原始订单 | 3 & 60次/min |
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 |
vip_api_trade_query.php | 查询原始订单 | 3 & 60次/min |
trade_modify.php | 修改订单标记 | 3 & 60次/min |
fa_api_account_detail_query.php | 查询平台账单 | 3 & 60次/min |
vip_invoice_info_query.php | 查询开票数据 | 3 & 60次/min |
vip_invoice_info_update.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 | 查询销售退货汇总 | 3 & 60次/min |
vip_api_refund_query.php | 查询原始退款单 | 3 & 60次/min |
接口服务名 | 接口名 | 并发量&频率/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 |
purchase_apply_query.php | 查询采购申请单 | 3 & 60次/min |
purchase_apply_push.php | 创建采购申请单 | 3 & 60次/min |
接口服务名 | 接口名 | 并发量&频率/min |
---|---|---|
stock_query.php | 增量查询库存 | 3 & 无 |
stock_sync_by_pd.php | 创建盘点单(调用日上限2000次) | 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 |
shop_stock_query.php | 查询店铺锁定库存 | 3 & 60次/min |
stockout_batch_detail.php | 查询出库类接口委外回传的效期和批次信息 | 3 & 60次/min |
stockin_batch_detail.php | 查询入库类接口委外回传的效期和批次信息 | 3 & 60次/min |
stat_stock_pd_detail_query.php | 查询盘点盈亏统计 | 3 & 60次/min |
stock_inout_sn_query.php | 序列号出入库查询 | 3 & 60次/min |
stock_goods_sn_query.php | 序列号管理查询接口 | 3 & 60次/min |