奇门白皮书-奇门对接方案

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

3. 奇门对接方案

3. 奇门对接方案

3.1 奇门对接方式

目前商家使用的各个业务系统之间依靠 ISV 帮助实现 ERP 到 WMS 的对接，如果有多仓需求的商家还需要使用到 2 套以上的第三方仓储服务所提供的 WMS 软件，ERP、WMS 各自对接，对接的总工作量为 N*N 倍，不但给 ISV 的开发带来了极大的成本，对于后期维护，也将是一项艰巨的任务，如下图所示：

通过奇门项目后可使原有的网状对接结构变为一对一的对接方式，ERP、 WMS 只需要与奇门数据总线对接一次即可完成所有系统的适配（特殊场景可能采用扩展字段的方式给与支持），如下图：

奇门项目后继接口升级方式将采用字段升级方式，在原有基础上加入更多的业务字段，同时业务接口向下兼容，开发过一次，后继如需更多的业务字段只需在原有接口层面加入业务字段即可，无需重新开发业务逻辑；

3.2 奇门标准化对接构架

前端 ERP 系统通过 TOP 平台与奇门应用进行对接，ERP 系统通过标准化通信协议、字段访问奇门系统，ERP 在此需要进行改造；

奇门应用主要提供字段映射、数据翻译、数据路由、账号权限、流控、数据打点等功能，能够让双方的请求通过奇门进行正常的传输，奇门还提供商家自定义扩展字段，通过奇门项目的通用数据通道进行传输，在标准协议不能完全支持的情况下，可以采用扩展字段的方式进行补充；

后端 WMS 系统通过 TOP 平台与奇门应用进行对接，WMS 系统通过标准化通信协议、字段调用奇门系统，WMS 在此也需要进行改造；

（可选）WMS 系统需要提供出能够在系统中新建用户、查询用户的 API，以供奇门项目应用调用，新商家接入时，奇门项目可以直接调用该 API 创建新的用户；

3.3 系统调用流程

正向调用：前端 ERP 系统通过 TOP 接口与奇门项目应用进行交互，对于想要发送到 WMS 的请求首先发送到奇门应用，由奇门负责数据的解析、字段映射、数据翻译，再将处理后的数据通过 ERP 系统所请求的目的地发送至 WMS 系统；WMS 系统收到请求后，将返回结果送回至奇门应用，由奇门应用统一返回至 ERP 系统；

反向调用：WMS 系统主动向 ERP 系统发出状态更新请求也是类似以上的访问步骤；

以下是简版软件流程图：

3.4 联调、测试方式

奇门项目支持 ERP 系统的正向调用以及 WMS 系统的反向调用，所以对于 ERP 系统以及 WMS 系统的测试方法并不一致，以下分别介绍 ERP 系统以及 WMS 系统的联调、测试方法：

3.4.1 ERP端

配置信息确认阶段：提前与 WMS 厂商进行沟通，根据商家的在 WMS 端的用户信息获取以下配置信息，并提供给奇门项目组，由奇门项目组完成在奇门当中的配置：

奇门标准字段	字段含义	备注	测试环境配置值
appkey	appkey	由开放平台分配，对应 ERP 软件的编码
customerid	用户 id	访问 WMS 系统的账号
secretkey	用户密码	该账号访问 WMS 系统的密码

1）开发接口阶段：奇门项目当中 ERP 端支持正向调用也支持反向调用，正向调用的 API 接口由 TOP 平台提供，ERP 端直接发起对沙箱环境的调用即可完成接口的测试工作，沙箱环境调用地址如下 (只需修改红色标示的 method 方法字段和 test_type 字段，test_type 值可以取 normal 和 error，normal 会返回该请求成功的应答，error 会返回该请求失败的应答) ：

http://qimenapi.tbsandbox.com/top/router/qimen/service?method= taobao.qimen.itemlack.report&timestamp=2015-04- 26%2000:00:07&format=xml&test_type=normal&app_key=testerp_app key&v=2.0&sign=abc&sign_method=md5&customerId=stub-custcode&uid=123456789

反向调用的 API 接口由 ERP 端提供，奇门会直接向 ERP 端发起调用，在此类型的 API 接口测试的过程当中，需要由服务商使用一个 Http Restful 接口的客户端向奇门发起反向调用；（推荐使用 Chrome 浏览器下的 REST Console 插件）

2）系统联调阶段：依次完成正向请求的开发与反向接口的工作后，与奇门项目组共同进行联调，在测试环境当中依次测试之前开发接口的业务逻辑；

3）系统发布阶段：与 WMS 端服务商共同确认正式环境的配置值，ERP 端直接发起对奇门正式环境的调用，需要将原有访问地址与具体配置地址切换成正式环境地址。

3.4.2 WMS 端

配置信息确认阶段：WMS 厂商需提前提供商家的在 WMS 端的用户信息以及如下的配置信息，提供给奇门项目组以及 ERP 端进行配置：

奇门标准字段	字段含义	备注	测试环境配置值
warehouseCode	仓库 id	仓储服务商分配给商家的仓库编码
customerid	用户 id	访问 WMS 系统的账号

1）开发接口阶段：奇门项目当中WMS端支持正向调用也支持反向调用，反向调用的API接口由TOP平台提供，WMS端直接发起对沙箱环境的调用即可完成接口的测试工作，沙箱环境调用地址如下 (只需修改红色标示的method方法字段和test_type字段，test_type值可以取normal和error，normal会返回该请求成功的应答，error会返回该请求失败的应答) ：

http://qimenapi.tbsandbox.com/router/qimen/service? method=taobao.qimen.itemlack.report&timestamp=2015-04-26%2000:00:07&format=xml&test_type=normal&app_key=【奇门沙箱Appkey】 &v=2.0&sign=abc&sign_method=md5&customerId=【奇门分配】 &uid=123456789

正向调用的API接口由WMS端提供，奇门会直接向WMS端发起调用，在此类型的API接口测试的过程当中，需要由服务商使用一个Http Restful接口的客户端向奇门发起正向调用；（推荐使用Chrome浏览器下的REST Console插件）

2）系统联调阶段：依次完成正向请求的开发与反向接口的工作后，与奇门项目组共同进行联调，在测试环境当中依次测试之前开发接口的业务逻辑；

3）系统发布阶段：WMS服务商与奇门共同确认正式环境的配置值，WMS端直接发起对奇门正式环境的调用，需要将原有访问地址与具体配置地址切换成正式环境地址。

FAQ

关于此文档暂时还没有FAQ

有用(0) 我要提问

淘宝开放平台

商家经营工具-开发指引