当前位置: 文档中心
自研系统&三方系统接入奇门自定义场景
注:对接奇门自定义API对接旺店通开放平台标准API,可实现的业务场景是相同的,所有需要从旺店通ERP获取淘系非敏感数据的,都需通过奇门自定义接口实现。
一、 奇门自定义API对接背景说明
1.1 国家在2017年6月1号正式实施《网络安全法》,法规明确网络运营者保障消费者数据的责任和义务。(阿里生态的合作伙伴,商家都属于网络运营者)
1.2 淘宝开放平台2017年5月18号发布数据安全违规排查公告,将于2017年6月1号开始做排查。公告地址:http://open.taobao.com/support/announcementDetail.htm?spm=a219a.7839801.0.0.xZ5mBu&id=25247
1.3 为了达到用户隐私数据安全保护的规范要求,奇门自定义中涉及到的用户隐私的字段数据将无法提供。
隐私字段列表
字段描述 | 字段名 |
---|---|
买家支付宝账号 | buyer_alipay_no |
卖家支付宝ID | alipay_id |
收货人姓名 | receiver_name |
收货人详细地址 | receiver_address |
收货人手机号码 | receiver_mobile |
收货人电话号码 | receiver_phone |
收货人邮箱 | receiver_email |
证件号 | id_card |
买家网名 | buyer_nick |
二、申请奇门appkey及创建应用
1.1 自研系统:商家自研发系统,参考“自研系统接入”流程申请appkey,“查看详情”。
1.2 三方系统:线下ERP(SAP、金蝶、用友等)、线下CRM,线下POS、WMS参考“三方系统接入”流程申请appkey,“查看详情”。
1.3 其他业务系统:自研及上述三方系统以外的系统,参考淘宝开放平台新手指南申请appkey,https://open.taobao.com/doc.htm?docId=118395&docType=1
注:只要拥有任意应用类型的淘宝开放平台appkey都可以对接奇门自定义场景下的API。
三、奇门自定义API对接实现
1.1 奇门介绍
奇门只是一个数据传输的通道,卖家只需要与奇门对接,将请求发送给奇门。奇门通过卖家请求参数中的目标appkey:target_app_key来锁定卖家目标请求的是旺店通,因此请求到旺店通接口,旺店通再通过奇门将数据返回给卖家。
针对原始形式的接口,如果客户需要对接三个系统,那么需要开发三套对接逻辑。改造成奇门接口之后,只要开发一套对接奇门的逻辑,改变参数target_app_key就可以对接任意系统。(前提是,该系统支持奇门对接)。
1.2 数据传输描述:
1.3旺店通对商家(服务商)奇门appkey授权,方式如下,授权后可开始进行测试开发
1.3.1 如果是奇门ERP-CRM场景、奇门自定义场景如下步骤申请联调
1.3.1 申请步骤:奇门场景申请联调,点击查看奇门自助指南(https://open.wangdian.cn/qjb/open/abut/zzzn_qimen)
1.3.2 邮件回复授权结果,并附带旺店通appkey(奇门API请求必传参数target_app_key)
1.4 测试开发
SDK下载(含使用说明):淘宝SDK及使用说明
测试开发过程问题解决:联调时会有相应联调群,问题在群中处理
奇门自定义API与旺店通标准API参数对比说明。
请求地址:
接口环境 | 奇门自定义api |
测试地址 | |
正式地址 |
接口名:
奇门自定义api | |
接口名举例 | method= wdt.purchase.purchasereturn.cancelorder(入参参数) |
奇门公共参数:
奇门自定义api | ||
奇门appkey | app_key | 奇门appkey,向奇门申请的8位数字 |
时间戳 | timestamp | 格式化后的时间戳2019-12-06 10:37:00 |
签名 | sign | API输入参数签名结果,签名算法介绍请点击这里 |
奇门接口名 | method | 参考原接口名转化refund_query=》wdt.refund.query |
目标appkey | target_app_key | 旺店通在奇门授权应用(授权通知邮件中提供) |
响应数据格式 | format | 响应格式。默认为xml格式,可选值:xml,json。 |
sign计算加密方式 | sign_method | md5 |
版本 | v | 固定值2.0 |
旺店通公共参数:
wdt3_customer_id | wdt3_customer_id | 旺店通自定义参数,该信息由旺店通分配 |
旺店通appkey | wdt_appkey | 旺店通开放平台应用管理中分配的appkey |
wdt_salt | wdt_salt | 旺店通开放平台应用管理中分配的appsecret后半部分 |
旺店通签名 | wdt_sign | 旺店通签名,计算方式点击 |
当前时间 | datetime | 当前时间,参考格式:2020-10-01 13:25:30 |
业务参数请求参数:
与旺店通标准API相同,可通过下述1.5奇门API与旺店通标准API对应关系,查看准确业务参数。查看旺店通标准API
响应参数:
奇门自定义api | |
正确响应 | data(与标准接口返回的data节点内容一致) |
错误响应 | "flag":"failure"(奇门增加一个flag字段,固定为failure)代表响应失败。 |
request_id(请求id) | |
code(奇门错误码) | |
message(奇门错误信息) | |
sub_code(旺店通错误码) | |
sub_message(旺店通错误信息) |
1.5奇门自定义API列表
分类 | 奇门接口名称(method) | 旺店通标准接口名称 | 接口描述 |
---|---|---|---|
基础类 | wdt.setting.shop.queryshop | setting.Shop.queryShop | 查询店铺详细信息 |
基础类 | wdt.setting.warehouse.querywarehouse | setting.Warehouse.queryWarehouse | 查询仓库详情信息 |
基础类 | wdt.setting.logistics.querylogistics | setting.Logistics. queryLogistics | 查询物流档案 |
基础类 | wdt.setting.purchaseprovider.querydetail | setting.PurchaseProvider.queryDetail | 查询供应商信息 |
基础类 | wdt.setting.purchaseprovider.push | setting.PurchaseProvider.push | 推送供应商信息 |
货品类 | wdt.goods.goods.push | goods.Goods.push | 推送货品档案 |
货品类 | wdt.goods.goods.querywithspec | goods.Goods.queryWithSpec | 查询货品档案 |
货品类 | wdt.purchase.providergoods.querydetail | purchase.ProviderGoods.queryDetail | 查询供应商货品 |
货品类 | wdt.goods.suite.search | goods.Suite.search | 查询组合装货品 |
货品类 | wdt.goods.apigoods.search | goods.ApiGoods.search | 查询平台货品 |
货品类 | wdt.goods.category.search | goods.Category.search | 平台类目查询 |
订单类 | wdt.sales.rawtrade.pushself | sales.RawTrade.pushSelf | 推送原始单 |
订单类 | wdt.sales.tradequery.querywithdetail | sales.TradeQuery.queryWithDetail | 查询订单 |
订单类 | wdt.wms.stockout.sales.querywithdetail | wms.stockout.Sales.queryWithDetail | 查询销售出库单 |
订单类 | wdt.sales.logisticssync.update | sales.LogisticsSync.update | 物流同步回传 |
订单类 | wdt.sales.logisticssync.getsynclistext | sales.LogisticsSync.getSyncListExt | 获取待同步列表 |
订单类 | wdt.finance.rawpayment.search | finance.RawPayment.search | 平台账单查询 |
订单类 | wdt.finance.alipayaccountcheck.search | finance.AlipayAccountCheck.search | 平台对账单查询 |
订单类 | wdt.sales.tradequery.queryhistorywithdetail | sales.TradeQuery.queryHistoryWithDetail | 历史订单查询 |
订单类 | wdt.wms.stockout.sales.queryhistorywithdetail | wms.stockout.Sales.queryHistoryWithDetail | 历史销售出库单查询 |
订单类 | wdt.sales.payment.querywithdetail | sales.Payment.queryWithDetail | 销售收付单查询 |
订单类 | wdt.finance.payment.search | finance.Payment.search | 收付款单查询 |
订单类 | wdt.sales.rawtrade.searchhistory | sales.RawTrade.searchHistory | 历史原始单查询 |
订单类 | wdt.sales.rawtrade.search | sales.RawTrade.search | 原始单查询 |
订单类 | wdt.wms.stockout.sales.querysalessnbatchdetail | wms.stockout.Sales.queryStockoutSalesSNBatchDetail | 销售出库序列号明细查询 |
售后类 | wdt.aftersales.refund.rawrefund.upload | aftersales.refund.RawRefund.upload | 推送原始退款单 |
售后类 | wdt.wms.stockin.refund.querywithdetail | wms.stockin.Refund.queryWithDetail | 查询退货入库单 |
售后类 | wdt.aftersales.refund.refund.search | aftersales.refund.Refund.search | 查询退换单 |
售后类 | wdt.wms.stockin.smartrefund.createext | wms.stockin.SmartRefund.createExt | 快速退货 |
售后类 | wdt.aftersales.refund.refund.searchhistory | aftersales.refund.Refund.searchHistory | 历史退换单查询 |
售后类 | wdt.aftersales.refund.rawrefund.search | aftersales.refund.RawRefund.search | 原始退款单查询 |
售后类 | wdt.wms.stockin.prestockin.createext | wms.stockin.PreStockin.createExt | 创建退货预入库单 |
售后类 | wdt.wms.stockin.prestockin.search | wms.stockin.PreStockin.search | 查询预入库单 |
售后类 | wdt.wms.stockin.refund.queryhiswithdetail | wms.stockin.Refund.queryHisWithDetail | 历史退货入库单查询 |
售后类 | wdt.aftersales.refund.rawrefund.searchhistory | aftersales.refund.RawRefund.searchHistory | 历史原始退款单查询 |
采购类 | wdt.purchase.purchaseorder.createorder | purchase.PurchaseOrder.createOrder | 创建采购单 |
采购类 | wdt.wms.stockin.purchase.upload | wms.stockin.Purchase.upload | 创建采购入库单 |
采购类 | wdt.purchase.purchaseorder.querywithdetail | purchase.PurchaseOrder.queryWithDetail | 查询采购单信息 |
采购类 | wdt.wms.stockin.purchase.querywithdetail | wms.stockin.Purchase.queryWithDetail | 查询采购入库单 |
采购类 | wdt.purchase.purchasereturn.createorder | purchase.PurchaseReturn.createOrder | 创建采购退货单 |
采购类 | wdt.purchase.purchasereturn.querywithdetail | purchase.PurchaseReturn. queryWithDetail | 查询采购退货单 |
采购类 | wdt.wms.stockout.purchasereturn.querywithdetail | wms.stockout.PurchaseReturn.queryWithDetail | 查询采购退货出库单 |
采购类 | wdt.purchase.purchasereturn.cancleorder | purchase.PurchaseReturn.cancelOrder | 取消采购退货单 |
采购类 | wdt.finance.settle.purchase.search | finance.settle.purchase.search | 查询采购结算单 |
库存类 | wdt.wms.stockspec.search | wms.StockSpec.search | 库存查询 |
库存类 | wdt.wms.stockspec.queryavailablestock | wms.StockSpec.queryAvailableStock | 可用库存查询 |
库存类 | wdt.wms.stockpd.stocksyncbypd | wms.StockPd.stockSyncByPd | 执行盘点 |
库存类 | wdt.wms.stockin.other.createotherstockinorder | wms.stockin.Other.createOtherOrder | 创建其他入库 |
库存类 | wdt.wms.stockout.other.createotherstockoutorder | wms.stockout.Other.createOther | 创建其他出库单 |
库存类 | wdt.wms.stockin.other.querywithdetail | wms.stockin.Other.queryWithDetail | 查询其他入库单 |
库存类 | wdt.wms.stockout.otherquery.querywithdetail | wms.stockout.OtherQuery.queryWithDetail | 查询其他出库单 |
库存类 | wdt.wms.stocktransfer.edit.createorder | wms.stocktransfer.Edit.createOrder | 创建调拨单 |
库存类 | wdt.wms.stockout.transfer.createorder | wms.stockout.Transfer.createOrder | 创建调拨出库单 |
库存类 | wdt.wms.stockin.transfer.querywithdetail | wms.stockin.Transfer.queryWithDetail | 创建调拨入库单 |
库存类 | wdt.wms.stockout.Transfer.queryWithDetail | wms.stockout.transfer.querywithdetail | 调拨出库单查询 |
库存类 | wdt.wms.stockin.Transfer.queryWithDetail | wms.stockin.transfer.querywithdetail | 调拨入库单查询 |
库存类 | wdt.wms.stocktransfer.manage.querywithdetail | wms.stocktransfer.Manage.queryWithDetail | 查询调拨单信息 |
库存类 | wdt.wms.moveorder.querywithdetail | wms.MoveOrder.queryWithDetail | 查询移位单 |
库存类 | wdt.wms.stockpd.querystockpdindetail | wms.StockPd.queryStockPdInDetail | 盘点入库单查询 |
库存类 | wdt.wms.stockpd.querystockpdoutdetail | wms.StockPd.queryStockPdOutDetail | 盘点出库单查询 |
库存类 | wdt.wms.stockother.in.push | wms.stockother.in.push | 其它入库业务单创建 |
库存类 | wdt.wms.stockother.out.push | wms.stockother.out.push | 其它出库业务单创建 |
库存类 | wdt.wms.stockshelve.querywithdetail | wms.StockShelve.queryWithDetail | 补货单查询 |
库存类 | wdt.wms.stockdefect.defectchange.search | wms.stockdefect.DefectChange.search | 正残转换单查询 |
库存类 | wdt.wms.stockother.outquery.querywithdetail | wms.stockother.OutQuery.queryWithDetail | 其它出库业务单查询 |
库存类 | wdt.wms.stockother.inquery.querywithdetail | wms.stockother.InQuery.queryWithDetail | 其它入库业务单查询 |
库存类 | wdt.wms.outer.outerout.createorder | wms.outer.OuterOut.createOrder | 外仓调整出库单创建 |
库存类 | wdt.wms.outer.outerin.createorder | wms.outer.OuterIn.createOrder | 外仓调整入库单创建 |
库存类 | wdt.wms.stockspec.querychangehistory | wms.stockspec.querychangehistory | 库存变化查询 |
四、上线
将测试环境地址:http://3ldsmu02o9.api.taobao.com/router/qmtest 变更为正式环境地址:http://3ldsmu02o9.api.taobao.com/router/qm