注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > 全渠道

奇门仓储业务介绍

更新时间:2017/03/07 访问次数:132861

前言

A. 对接奇门前需在服务市场发布应用,具体如下:

    (1)WMS:走“仓储管理系统(WMS)”类目应用接入流程,取得应用appkey,若已发布过请忽略。发布流程  点此查看

    (2)ERP(第三方服务商):走“企业ERP”类目应用接入流程,取得应用appkey,若以前发布过请忽略(当前ERP入驻审核较严)。发布流程 点此查看

    (3)ERP(商家自研系统):申请地址点击查看

B. 奇门仓储业务API接口说明文档:点击查看

C. 接口报错怎么办?有任何问题请先自查,遇到的问题这里都会找到解决方案: 点此查看奇门异常排查手册 ;其他日常问题咨询请到支持中心进行提问:点此进入开放平台支持中心。旺旺群仅处理线上故障问题,群号:132615531

D. 奇门参数配置请使用chrome登陆ITC ,ITC使用说明:点此查看ITC教程

E. 奇门API接口请务必使用SDK包,下载SDK请移步开放平台-控制台-应用管理,申请“奇门仓储业务”API权限包,SDK内核心代码以及SDK的使用demo可点此通过云盘下载 (提取码:4Q6Zwm) 

 

1.业务背景

    当前奇门项目支持ERP-WMS系统标准化对接,通过构建系统之间标准通信协议来实现不同系统之间的打通。


 

2.奇门对接方案

2.1 奇门对接流程

1. 接口开发

阅读奇门仓储API说明文档,完成所需接口的开发,只需要开发自己需要使用的接口。

2. 挡板自测

也称和挡板联调,目的是让第一次对接奇门的开发者了解奇门的对接逻辑,如果您是ERP,则平台会模拟WMS和您完成自测。首先需要配置自测的参数(参数包括:CUSTOMERID(商家的唯一标识)、ERP_APPKEY(ERP的应用ID)、ERP_URL(反向接口的服务地址,ERP提供),WMS_APPKEY(WMS的应用ID)、WMS_URL(正向接口的服务地址,WMS提供)),参数是测试数据,customerId由奇门临时分配(以c开头的一串编号),配置请移步ITC。(1)ERP测试正向:ERP发起接口调用,奇门挡板会模拟WMS向ERP返回响应;(2)ERP测试反向,需要ERP模拟WMS向自己发起调用请求,测试自己的ERP系统是否能接收到请求并正确响应。WMS挡板自测同理。
奇门测试环境地址:http://qimenapi.tbsandbox.com/router/qimen/service

3. 三方联调

自测通过之后开始三方联调(ERP-奇门-WMS),联调需要重新配置联调参数,customerId由奇门临时分配,需要ERP发起联调申请,WMS来接收申请,配置方法同上,请移步ITC。奇门地址和自测时候一样:http://qimenapi.tbsandbox.com/router/qimen/service

4. 商家验收

联调通过后,上线需要配置正式参数,customerId是WMS为商家分配的唯一的真实账号,商家发布真实商品进行验收。正式环境的配置同上,请移步ITC。奇门正式环境地址:http://qimen.api.taobao.com/router/qimen/service。

 

整个奇门ERP与WMS互相调用的时序图如下所示,分正向反向。所谓的正向,我们约定为ERP发起,调用WMS的接口,接口实现方是WMS(如:商品同步接口,出库单创建和入库单创建接口等);同理,反向即WMS发起,调用ERP的接口,接口实现方是ERP(如:出库、入库确认接口,缺货通知接口等)。

 

        

2.2 奇门质量中心

          奇门质量中心就是奇门的ISV控制台,整合了自测和联调的奇门参数配置工具,线上和测试环境的日志查询工具。

          

2.3 奇门ITC工具

         奇门完成ERP-WMS的联通,需要配置路由参数,配置的地方请移步ITC,ITC的使用说明见ITC首页。

 

2.4 接口协议

          奇门总共有两个环境,分别是日常环境(即沙箱环境)和线上环境,其中日常环境配置的都是测试数据,线上环境配置的都是真实数据。沙箱地址:http://qimenapi.tbsandbox.com/router/qimen/service,线上地址:http://qimen.api.taobao.com/router/qimen/service。

  在奇门的参数配置中主要涉及到下面几个重要参数

1)     ERP_APPKEY

2)     ERP_URL

3)     WMS_APPKEY

4)     WMS_URL

5)     CUSTOMER_ID(测试环境由奇门来临时分配)

那么奇门路由的策略是怎样的呢?下面是一段标准的调用URL的例子:

http://qimenapi.tbsandbox.com/router/qimen/service?method=****&timestamp=2015-04-26 20:00:07&format=xml&app_key=****&v=2.0&sign=abc&sign_method=md5&customerId=****

其中,各个字段的含义,请见下表:

字段名

含义

域名

http://qimenapi.tbsandbox.com/router/qimen/service

是奇门测试环境的域名地址,自测和联调的时候都是使用这个域名,注意,千万不要直接写成对方ISV应用的服务地址

Method

调用的方法

timestamp

使用当前调用接口的时间,做encode编码

format

暂时只支持xml

appkey

调用方自己的appkey,即来源appkey

sign

MD5加密,加密策略参看附录1

customerId

是仓储为这个用户分配的唯一的用户帐号,自测和联调的时候由奇门统一分配,等到切到预发和正式环境的时候,使用仓储自己分配真实的值,注意,对于一个WMS,这个customerId一定要保证唯一

 

2.4.1 ERP与奇门的通信协议

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

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

ERP发给奇门(正向接口):

http://qimen.api.taobao.com/router/qimen/service?method=[qimen_API]&timestamp=[2015-02-01 00:00:00]&format=xml&app_key=[erp_appkey]&v=2.0&sign=[xxxxxxxxxxxxxxxxxxxxxx]&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. []中需要根据具体业务进行填写。
  2. 请求和响应的消息主体使用XML格式。

 

2.4.2 奇门与WMS的通信协议

接口遵循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&customerId=[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=[xxxxxxxxxxxxxxxxxxxxxx]&sign_method=md5&customerId=[QIMENUSR1]

注:

  1. []中需要根据具体业务进行填写。qimen_API。
  2. 请求和响应的消息主体使用XML格式。

 

2.4.3 接口说明

注:所有非叶子节点下都可以增加remark和extendProps

  • remark

<remark>备注,string(500)</remark>

  • extendProps使用key-value结构,

<extendProps>扩展属性

          <key1>value1</key1>

          <key2>value2</key2>

           …

         </extendProps> 

FAQ

关于此文档暂时还没有FAQ
返回
顶部