当前位置: 文档中心
接口规范说明
1. 通讯协议
REST风格的API,使用HTTP协议发送POST请求调用接口。
HTTP请求头类型为 Content-Type: application/json 或者 Content-Type: application/xml,暂不支持Content-Type: application/x-www-form-urlencoded。
2. 报文及报文编码
报文为UTF8编码,支持半角、中文、英文、数字、基本标点符号,请注意不要有表情符号等各种非法字符,会导致数据库写入失败。
请求报文body为json或xml格式。
为了保证传输数据的安全性,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://47.92.239.46/openapi
2)正式环境:http://wdt.wangdian.cn/openapi
3.3.2 公共请求参数
每个接口都必须输入的参数。接口文档该部分阐述了请求报文中公共请求参数的含义及注意事项,参数详见下述表格。
注:appsecret作为校验数据安全使用,不要将它作为公共参数传输到互联网中。
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
卖家账号 | sid | String | 是 | 购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。 | |
接口账号 | key | String | 是 | 由旺店通分配appkey, 在发送的数据中对应 key 字段 | |
密钥 | appsecret | String | 是 | 由旺店通分配appsecret,是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt. | |
接口名称 | method | String | 是 | 调用的接口名称 | |
版本号 | v | String | 是 | 1.0 | |
秒级时间戳 | timestamp | int | 是 | 秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。 | |
签名 | sign | String | 是 | 签名 | |
分页大小 | page_size | int | 否 | 分页大小,分页查询必传 | |
分页编号 | page_no | int | 否 | 分页编号,分页查询必传,标准接口page_no从0开始 | |
是否计算查询结果的总条数 | calc_total | int | 否 | 是否计算查询结果的总条数, 需要计算则1, 否则填0 |
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 |
---|---|---|
setting.Logistics.queryLogistics | 物流公司查询 | 3 & 60次/min |
setting.PurchaseProvider.queryDetail | 供应商查询 | 3 & 60次/min |
setting.Warehouse.queryWarehouse | 仓库查询 | 3 & 60次/min |
setting.Shop.queryShop | 店铺查询 | 3 & 60次/min |
setting.PurchaseProvider.push | 供应商信息推送 | 3 & 60次/min |
setting.Shop.updateShop | 店铺更新 | 3 & 60次/min |
setting.Employee.search | 员工查询 | 3 & 60次/min |
setting.strategy.VirtualWarehouse.warehouseSearch | 虚拟仓库存查询 | 3 & 60次/min |
setting.CustomAttr.getTradeProp | 订单自定义属性查询 | 3 & 60次/min |
接口服务名 | 接口名 | 并发量&频率/min |
---|---|---|
goods.Goods.push | 货品推送 | 3 & 60次/min |
goods.Suite.search | 组合装查询 | 3 & 60次/min |
goods.Goods.queryWithSpec | 货品档案查询 | 3 & 60次/min |
goods.ApiGoods.search | 平台货品查询 | 3 & 60次/min |
goods.ApiGoods.upload | 平台货品推送 | 3 & 60次/min |
process.Bom.upload | 物料清单推送 | 3 & 60次/min |
process.Process.upload | 生产单推送 | 3 & 60次/min |
process.Process.search | 生产单查询 | 3 & 60次/min |
goods.GoodsClass.search | 货品分类查询 | 3 & 60次/min |
goods.GoodsBrand.search | 货品品牌查询 | 3 & 60次/min |
goods.Category.search | 平台类目查询 | 3 & 60次/min |
goods.Goods.batchPush | 货品批量推送 | 3 & 60次/min |
process.Bom.search | 物料清单查询 | 3 & 60次/min |
goods.Barcode.upload | 条码上传 | 3 & 60次/min |
goods.GoodsClass.upload | 新建分类 | 3 & 60次/min |
接口服务名 | 接口名 | 并发量&频率/min |
---|---|---|
wms.stockin.SmartRefund.upload | 快速退货 | 3 & 60次/min |
wms.stockin.Refund.queryWithDetail | 退货入库单查询 | 3 & 60次/min |
wms.stockin.PreStockin.cancel | 退货预入库单取消 | 3 & 60次/min |
aftersales.refund.RawRefund.upload | 原始退款单推送 | 3 & 60次/min |
aftersales.refund.Refund.search | 退换单查询 | 3 & 60次/min |
aftersales.refund.Refund.searchHistory | 历史退换单查询 | 3 & 60次/min |
aftersales.refund.RawRefund.search | 原始退款单查询 | 3 & 60次/min |
wms.stockin.PreStockin.createExt | 创建退货预入库 | 3 & 60次/min |
aftersales.refund.RawRefund.upload2 | 原始退款单推送2 | 3 & 60次/min |
wms.stockin.Refund.createOrder | 退货入库单推送 | 3 & 60次/min |
wms.stockin.Refund.queryHisWithDetail | 历史退货入库单查询 | 3 & 60次/min |
aftersales.refund.RawRefund.searchHistory | 历史原始退款单查询 | 3 & 60次/min |