文档中心 > 自研电商后台系统-开发指引

奇门白皮书-接口规范

更新时间：2023/06/29 访问次数：54961

4. 接口规范

4. 接口规范

4.1 ERP 与奇门的通信协议

4.1.1 协议描述

接口遵循 REST 规范，使用 HTTP POST 方式进行通讯。

标准协议的 HTTP 入口地址为：

ERP 发给奇门：

http://qimen.api.taobao.com/router/qimen/service?method=[qimen _API]&session=[1000]&timestamp=[2015-02-01 00:00:00]&format=xml&app_key=[erp_appkey]&v=2.0&sign=[xxxxxxxxx xxxxxxxxxxxxx]&sign_method=md5&customerId=[QIMENUSR1]

奇门发给 ERP：

http://[erp_webservice_url]?method=[erp_API] &timestamp=[2015- 02-01 00:00:00]&format=xml&app_key=[wms_appkey]&v=2.0&sign=[xxxxxxxxxxxxxxxxxxxxxx]&sign_method=md5&customerId=[QIMENUSR1]

注：

1）[]中需要根据具体业务进行填写。qimen_API，erp_API 具体见下方的 API 名称。

2）URL 需要做 URL Encoding 处理。

3）请求和响应的消息主体使用 XML 格式。

4.1.2 访问授权

需要商家提供 TOP 的 sessionkey（session）以及该商家在对应 wms 系统的客户 ID（customerID）和密钥（用于计算 sign）。

4.1.3 请求参数说明

请求参数包含 URL 中带的系统参数和 BODY 中带的相关业务参数，系统参数如下：

参数	参数说明	类型	约束
method	ERP 相关的业务接口名称，如商品信息同步的请求， method= taobao.qimen.item.synchronize	string	必须
timestamp	时间戳，格式为 yyyy-mm-dd HH:mm:ss	string	必须
format	content 格式	string	目前支持 XML
app_key	应用接入时申请的 appkey	string	ERP 的 appkey
v	协议版本号，1.0 或者 2.0	string	必须
sign	根据 url 和密钥计算的结果。具体算法参看附录 1	string	必须
sign_method	参数加密方法，md5	string
customerid	WMS 颁发给用户的 ID	string	必须

4.1.4 响应参数

响应参数包含系统参数和业务参数，系统参数如下：

参数	参数说明	类型	约束
flag	success\|failure	string（50）	必须
code	返回状态码	string（50）	必须
message	返回状态描述	string（200）	必须

4.2 奇门与 WMS 的通信协议

4.2.1 协议描述

接口遵循 REST 规范，使用 HTTP POST 方式进行通讯。

标准协议的 HTTP 入口地址为：

奇门发给 WMS：

http://[wms_webservice_url]?method=[wms_API] &format=xml&app_key=[erp _appkey]&v=2.0&sign=[xxxxxxxxxxxxxxxxxxxxxx]&sign_method=md5&c ustomerId=[QIMENUSR1]

WMS 发给奇门：

http://qimen.api.taobao.com/router/qimen/service?method=[qimen _API] &timestamp=[2015-02-01 00:00:00]&format=xml&app_key=[wms_appkey]&v=2.0&sign=[xxxxxxx xxxxxxxxxxxxxxx]&sign_method=md5&customerId=[QIMENUSR1]

注：

1）[]中需要根据具体业务进行填写。qimen_API，wms_API 具体见下方的 API 名称。

2）URL 需要做 URL Encoding 处理。

3）请求和响应的消息主体使用 XML 格式。

4.2.2 请求参数

请求参数包含 URL 中带的系统参数和 BODY 中带的相关业务参数，以下是系统参数：

参数	参数说明	类型	约束
method	WMS相关的业务接口名称，如商品信息同步的请求，method= item.synchronize	string	必须
format	content格式	string	目前支持XML
app_key	应用接入时申请的appkey	string	WMS的appkey
v	协议版本号，1.0或者2.0	string	必须
sign	根据url和密钥计算的结果。具体算法参看附录1	string	必须
sign_method	参数加密方法，md5
customerid	WMS颁发给用户的ID	string	必须

4.2.3 响应参数

响应参数包含系统参数和业务参数。以下是系统参数：

参数	参数说明	类型	约束
flag	success\|failure	string（50）	必须
code	返回状态码	string（50）	必须
message	返回状态描述	string（200）	必须

FAQ

关于此文档暂时还没有FAQ

有用(0) 我要提问

开放平台

自研电商后台系统-开发指引