奇门聚石塔内外互通说明

更新时间：2024/07/31 访问次数：175938

一、说明
二、API接入
三、挡板说明

一、说明

聚石塔内外互通是指比如仓储，POS、ERP、CRM等场景下企业内部系统之间对接的一种方式，协议由官方奇门接口定义，开发者只需实现即可接口功能，避免出现不同企业之间协议不同的问题。如果接入者对协议有疑问或者有任何建议，也可以向奇门支持小二反馈。目前奇门接口都是免费开放使用。

在聚石塔内实现一个奇门接口服务端，在外部独立系统里面发起奇门接口调用；也可以在外部独立系统里面实现奇门接口服务端，聚石塔内发起调用。常见的ERP-WMS，ERP-POS，线上ERP-线下ERP场景都属于聚石塔互通模式。

品牌商自研系统互通

多服务商之间奇门互通

塔外部署的系统也需要申请单独的appkey，用来与塔内的应用做奇门接口调用的映射关系绑定和鉴权。

1）如果系统开发为第三方ISV：

① 非淘ERP：非淘ERP要与WMS通过奇门对接，需要申请应用appkey，不处理淘系订单。申请地址点击查看；

② WMS系统：申请地址点此查看；

③ 线下ERP（或财务系统）：申请地址点此查看；

2）如果系统开发为天猫商家自研：

① 商家自研WMS：申请地址点击查看；

② 商家自研线下ERP（或财务系统）：申请地址点此查看；

注意——其中WMS系统申请时要求提供的软著名称必须包含“WMS”或“仓储管理”字样；

ISV角色的WMS申请要求提供的软著著作权人和申请账号绑定的支付宝实名认证公司完全一致；’

自研WMS 可以用关联关系证明，格式不限，附在产品说明书中

自研发软件著作权，该软著必须是店铺所属公司 / 全资子公司 /全资母公司 /同公司 / 同集团 / 同法人公司的自研发软件的独立软件著作权，软著所属主体和店铺主体在法律上必须是有关联的

可用官方场景

ERP与WMS奇门仓储官方场景	查看详情
线上ERP-线下OMS奇门官方场景	查看详情
ERP-POS奇门官方场景接口说明	查看详情

二、API接入

1. 关联场景

1）登录奇门控制台；

2）选择三方互通-场景列表；

3）选择对应的场景，确定可接入的标签列表是否包含您的应用标签，如果没有请联系小二申请。找到对应场景后点击“进入”。

4）选择应用，选择对应的角色，注意角色需要谨慎选择，如果没有包含您的角色，请联系小二添加。

注意点

① 场景对应的APPKEY即使已经在官方场景里做了关联，也需要在三方互通里面再做一次关联。

② 选择角色时候请判断是否存在。

2. 自测

① 左侧菜单栏选择三方互通-我的场景-确定场景以及appkey-点击“进入”。

② 点击“自测”或者对应API后面的“接入”。

1）服务地址配置

① 配置您服务的测试地址。

② 选择新增API，选择需要实现的API，需要调用的API不需要添加。

③ 完成后点击“保存配置并进入到下一步”。

2）服务地址自测

① 点击“自测”可以开始进行测试。

② 点击“查看结果”可以查看请求的结果。

③ 可以通过编辑用例修改请求例子。

3）API自测

① 系统检测的API是您需要实现的API。点击“自测”，系统会对系统检测的API执行检测。

② 手工检测的API是您发起调用的API，在对方未接入API前，您也可以测试调用您的请求是否正确，具体参考下文《挡板说明》。
联调

③ 完成自测后点击“联调”可以进入联调页面。

④ 点击发起联调，配置相关配置。发起后需要通知对方做相应的配置。
联调调用

⑥ 双方建立联调后系统会分配一个customerid，联调时候需要指定该customerid（奇门仓储要求，其他场景不用指定customerid）

⑦ 联调域名：https://qimen.api.taobao.com/top/router/qmtest

3. 上线

1）点击“上线”进入上线配置页面。

2）点击上线申请进行线上授权申请，目前只支持部分角色发起，如果您没有该按钮，请联系对方发起申请。

非淘店铺名填写规则

① 非淘店铺名填写规则。

② 填写规则：平台名缩写_店铺名，比如“POS_xxx旗舰店”，如果平台不在列表内则联系小二添加即可。

平台名列表: JD=京东、DD=当当、PP=拍拍、YX=易讯、EBAY=ebay、QQ=QQ网购、AMAZON=亚马逊、SN=苏宁、GM=国美、WPH=唯品会、JM=聚美、LF=乐蜂、MGJ=蘑菇街、JS=聚尚、PX=拍鞋、YT=银泰、YHD=1号店、VANCL=凡客、YL=邮乐、YG=优购、POS=POS门店、MIA=蜜芽、GW=商家官网、CT=村淘、YJWD=云集微店、PDD=拼多多、XHS=小红书、YZ=有赞、GGJ=格格家、线下店铺=OFFLINE、小黑鱼=XHY、全球购=QQG、好医生=HYS、分期乐=FQL、亲宝宝=QBB、微盟=WM、每日一淘=MRYT、衣脉=YM、泰然城=TYC、HQBS=环球捕手、BD=贝店、WLJS=未来集市、XMYP=小米有品、WYKL= 网易考拉、WOOY=沃赢商圈、HSQ=好食期、XCCHJY=小船出海教育、TTMB=天淘麦坝、BW=臂湾、DC=单创、YQYX=云企优选、JW=金文、FXG=放心购、DJ=鼎捷、LONGSKY=长远软件、AQYSC=爱奇艺商城、GZG=公主购、 TRGF=天然工坊商城、PD=拍店、LAZADA=来赞达、DYXD=抖音小店、BLM=波罗蜜、YH=有货、DW=得物、DWZF=得物直发、NNCLUB=NNZY、TMGJ=天猫国际、TMCS=天猫超市、DYGX=抖音供销、BOLO=菠萝科技、WXXD=微信小店、HWSC=华为商城、QC=圈层、NXSC=农信商城、KS=快手、SH=食亨、YFD猿辅导、QYL=轻引力、 CNRMALL= 央广购物、TF=同福科技

4. 配置授权

1）可以在该页面查看授权记录。

2）如果需要修改服务地址，可以在该页面做地址修改。

三、挡板说明

在双方进行联调时，对方还未对接API，此时调用方可以请求挡板帮来模拟请求对方，挡板会返回mock数据给请求方。这样请求方可以提前实现自测。使用挡板不需要做任何配置，直接使用即可。

对于普通场景，只需要请求时候指定targetAppkey为指定appkey(25829845)即可：

request.setTargetAppKey("25829845");

对于奇门仓储场景，只需要指定明customerId为mockCustomerId即可。

request.setCustomerId("mockCustomerId");

FAQ

关于此文档暂时还没有FAQ

有用(0) 我要提问

淘宝开放平台

商家经营工具-开发指引