文档中心 > 奇门中心

奇门仓储API接入流程(新)

更新时间:2017/10/09 访问次数:25133

接入流程

入驻奇门 -> 选择官方场景 -> API实现 -> 配置授权 -> API自测 -> 发布上线 -> 配置授权 -> 对方调用

对于某些场景的需要涉及双方联调的,需要双方各自把API自测完发布上线才能联调。举个例子,ERP和MWS对接,则接入流程如下:
ERP自测 - ERP上线 - 配置wms授权 - MWS调用ERP联调ERP接口
WMS自测 - WMS上线 - 配置ERP授权 - ERP调用wms联调wms接口

选择官方场景

选择『奇门仓储业务』,如果没有的话则需要联系运营小二添加

API实现

API预览

在api预览页面可以了解api的入参,出参情况。另外也可以在页面奇门仓储API查看仓储API的配置。

接口实现

按照之前定义的API来实现服务的逻辑。 响应结构体一定要按API定义的来实现,具体的响应例子可以在API上查看,比如发货单查询接口

API自测

1 在授权配置页面添加测试的customerId

  • 点击授权配置
  • 选择正式环境
  • 选择根据API,选择对应的API
  • 添加测试使用的customerid
  • 添加后端服务的地址(注意不是奇门地址,而是提供服务的服务地址)
  • 点击添加

image | center

2 自测页面测试

image | center

API发布

如果自测通过,则可以点击『自测通过请发起服务验证』,此时系统会发起非法请求请求服务后端,如果后端不满足验签逻辑则提示错误。具体验签逻辑参考上文。验证通过可以点击发布上线。

发布上线后,请在自测页面选择正式环境测试是否成功发布成功。

添加授权

API发布后需要需要添加对别的appkey的授权别的appkey才能发起调用。如果报TOP60『路由』相关的错误都需要在这里添加授权。

  • 点击『官方服务』- 找到所属应用 - 点击『管理』

image | center

如果提示不是奇门开发者,则需要先申请加入:
image | center

  • 点击『授权配置』-『新增授权应用』 点击『保存』。这里授权的appkey为调用方的appkey

image | right

  • 点击『配置奇门授权』,选择API,填写customerId,填写自己的后端地址,并点击添加

image | center

  • 添加完成即可。如果要验证,可以让 **调用方 **在登录qimen.taobao.com,选择appkey,管理,进入『API测试』页面测试。注意环境选择正式环境。

image | center

  • 线上报TOP60路由错误,需要在哪一方添加对授权配置呢?比如下面的请求:
taobao.erp.returnorder.sync^_^10.116.215.204^_^Linux^_^96^_^http://qimen.api.taobao.com/router/qm^_^process=%7B%22processStatus%22%3A%22FULFILLED%22%7D&sign_method=hmac-sha256&timestamp=2017-09-11+16%3A56%3A00&sign=BCFB01AB929ABF10E21BF5B7B3B2B86701E42A0B1DFA1FDCCBA875138C0DDF64&customerId=0210044048&order=%7B%22orderCode%22%3A%228c4e0bef-8ffd-488c-a21a-43026d626066%22%2C%22orderId%22%3A%22FXRK20170908000383%22%2C%22warehouseCode%22%3A%2223132%22%7D&method=taobao.erp.returnorder.sync&app_key=21074842&format=json&target_app_key=23108338^_^{"response":{"flag":"failure","code":66,"message":"qimen cloud inernal error","sub_message":"找不到对应的路由信息","request_id":"46hdmu37qt37"}}

需要在target_app_key=33108338方添加对app_key=31074842的授权,也就是说在target_app_key=33108338的控制台配置 授权调用的appkey=31074842 并根据上面步骤添加后端路由。

#

调用接口

API 发布上线后调用方可以通过下面步骤来调用。

SDK的下载

点击『应用管理』, 『SDK下载』可以下载SDK。
image | center

image | center

image | center

接口调用

可以在API接口页面查看调用的方式,比如发货单创建接口的请求示例

FAQ

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