当前位置: 文档中心
自研系统&三方系统接入奇门自定义场景
注:"奇门自定义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 奇门自定义场景如下步骤申请联调,联调协助方式:点击“联系我们”查看入群方式,入群沟通联调相关事项:
商家方登录开放平台:在“自助对接”—“奇门自助指南”中,根据指引步骤进行联调申请操作:
1.3.2 收到联调通过邮件回复授权结果,并附带旺店通appkey(奇门API请求必传参数target_app_key)
1.4 测试开发
请求地址:
接口环境 | 旺店通标准api | 奇门自定义api |
测试地址 | http://sandbox.wangdian.cn/openapi2/接口服务名 | http://hu3cgwt0tc.api.taobao.com/router/qmtest |
正式地址 | http://api.wangdian.cn/openapi2/接口服务名 | http://hu3cgwt0tc.api.taobao.com/router/qm |
接口名:
旺店通标准api | 奇门自定义api | |
接口名举例 | http://sandbox.wangdian.cn/openapi2/接口服务名 | method=wdt.trade.query(入参参数) |
公共参数:
旺店通标准api | 奇门自定义api | |||
卖家账号 | sid | wdt2 | sid | wdt2 |
应用授权 | appkey | 旺店通授权应用(卖家账号-后缀:wdt2-ot) | app_key | 奇门授权应用(21xxxxxx) |
时间戳 | timestamp | 1575599760 | timestamp | 格式化后的时间戳2019-12-06 10:37:00 |
签名 | sign | sign | 奇门签名计算规则 | |
奇门接口名 | method | 参考原接口名转化refund_query=》wdt.refund.query | ||
目标appkey | target_app_key | 旺店通在奇门授权应用(授权通知邮件中提供) | ||
响应数据格式 | format | 固定值json | ||
sign计算加密方式 | sign_method | 固定值md5 | ||
版本 | v | 固定值2.0 |
业务参数:
与旺店通标准API相同,可通过下述1.5奇门API与旺店通标准API对应关系,查看准确业务参数。查看旺店通标准API
响应参数:
旺店通标准api | 奇门自定义api | |
正确响应 | code | errorcode |
message | message | |
错误响应 | "flag":"failure"(奇门增加一个flag字段,固定为failure)代表响应失败。 | |
request_id(请求id) | ||
code(奇门错误码) | ||
message(奇门错误信息) | ||
code | sub_code(旺店通错误码) | |
message | sub_message(旺店通错误信息) |
1.5奇门自定义API列表
分类 | 奇门接口名称(method) | 旺店通标准接口名称 | 接口描述 |
---|---|---|---|
基础类 | wdt.shop.query | shop.php | 查询店铺详细信息 |
基础类 | wdt.warehouse.query | warehouse_query.php | 查询仓库详情信息 |
基础类 | wdt.logistics.query | logistics.php | 查询物流档案 |
基础类 | wdt.purchase.provider.query | purchase_provider_query.php | 查询供应商信息 |
基础类 | wdt.purchase.provider.create | purchase_provider_create.php | 创建供应商信息 |
货品类 | wdt.goods.push | goods_push.php | 创建货品档案 |
货品类 | wdt.goods.query | goods_query.php | 查询货品档案 |
货品类 | wdt.api.goodsspec.push | api_goodsspec_push.php | 创建平台货品 |
货品类 | wdt.vip.api.goods.query | vip_api_goods_query.php | 查询平台货品 |
货品类 | wdt.suites.query | suites_query.php | 查询组合装货品 |
货品类 | wdt.suites.push | suites_push.php | 创建组合装 |
货品类 | wdt.goods.brand.query | goods_brand_query.php | 查询货品品牌 |
货品类 | wdt.goods.class.query | goods_class_query.php | 查询货品分类 |
订单类 | wdt.trade.push | trade_push.php | 创建原始订单 |
订单类 | wdt.trade.query | trade_query.php | 查询订单管理 |
订单类 | wdt.stockout.order.query.trade | stockout_order_query_trade.php | 查询销售出库单 |
订单类 | wdt.logistics.sync.query | logistics_sync_query.php | 查询物流同步 |
订单类 | wdt.logistics.sync.ack | logistics_sync_ack.php | 物流同步状态回写 |
订单类 | wdt.api.goods.stock.change.query | api_goods_stock_change_query.php | 查询库存同步 |
订单类 | wdt.api.goods.stock.change.ack | api_goods_stock_change_ack.php | 平台货品库存同步状态回写 |
订单类 | wdt.vip.trade.modify | vip_trade_modify.php | 修改订单标记 |
订单类 | wdt.vip.stat.sales.by.spec.shop.warehouse.query | vip_stat_sales_by_spec_shop_warehouse_query.php | 查询销售汇总 |
订单类 | wdt.fa.api.account.detail.query | fa_api_account_detail_query.php | 查询平台账单 |
订单类 | wdt.vip.api.trade.query | vip_api_trade_query.php | 查询原始订单 |
订单类 | wdt.vip.trade.batch.modify | vip_trade_batch_modify.php | 批量修改订单标记 |
订单类 | wdt.fa.alipay.account.check.query | fa_alipay_account_check_query.php | 查询平台对账 |
售后类 | wdt.sales.refund.push | sales_refund_push.php | 创建原始退款单 |
售后类 | wdt.stockin.refund.push | stockin_refund_push.php | 创建退货入库单 |
售后类 | wdt.refund.query | refund_query.php | 查询退换管理 |
售后类 | wdt.stockin.order.query.refund | stockin_order_query_refund.php | 查询退货入库单 |
售后类 | wdt.vip.stat.refund.by.spec.shop.warehouse.query | vip_stat_refund_by_spec_shop_warehouse_query.php | 查询销售退货汇总 |
售后类 | wdt.vip.api.refund.query | vip_api_refund_query.php | 查询原始退款单 |
售后类 | wdt.stockin.pre.order.query | stockin_pre_order_query.php | 查询退货预入库单 |
采购类 | wdt.purchase.order.push | purchase_order_push.php | 创建采购单 |
采购类 | wdt.stockin.purchase.push | stockin_purchase_push.php | 创建采购入库单 |
采购类 | wdt.purchase.order.query | purchase_order_query.php | 查询采购单信息 |
采购类 | wdt.purchase.apply.query | purchase_apply_query.php | 查询采购申请单 |
采购类 | wdt.stockin.order.query.purchase | stockin_order_query_purchase.php | 查询采购入库单 |
采购类 | wdt.purchase.return.push | purchase_return_push.php | 创建采购退货单 |
采购类 | wdt.purchase.return.order.push | purchase_return_order_push.php | 创建采购退货出库单 |
采购类 | wdt.purchase.return.query | purchase_return_query.php | 查询采购退货单 |
采购类 | wdt.stockout.order.query.return | stockout_order_query_return.php | 查询采购退货出库单 |
采购类 | wdt.purchase.apply.push | purchase_apply_push.php | 创建采购申请单 |
采购类 | wdt.purchase.apply.query | purchase_apply_query.php | 查询采购申请单 |
采购类 | wdt.purchase.order.end | purchase_order_end.php | 取消采购单 |
采购类 | wdt.purchase.return.end | purchase_return_end.php | 取消采购退货单 |
采购类 | wdt.purchase.order.end.wms | purchase_order_end_wms.php | 取消委外采购单 |
库存类 | wdt.stock.query | stock_query.php | 增量查询库存 |
库存类 | wdt.stock.sync.by.pd | stock_sync_by_pd.php | 创建盘点开单 |
库存类 | wdt.stock.pd.order.query | stock_pd_order_query.php | 查询盘点单 |
库存类 | wdt.stockin.order.push | stockin_order_push.php | 创建其他入库 |
库存类 | wdt.stockin.order.query | stockin_order_query.php | 查询入库单管理 |
库存类 | wdt.stockout.order.push | stockout_order_push.php | 创建其他出库单 |
库存类 | wdt.stockout.order.query | stockout_order_query.php | 查询出库单管理 |
库存类 | wdt.stock.transfer.push | stock_transfer_push.php | 创建调拨单 |
库存类 | wdt.stockout.transfer.push | stockout_transfer_push.php | 创建调拨出库单 |
库存类 | wdt.stockin.transfer.push | stockin_transfer_push.php | 创建调拨入库单 |
库存类 | wdt.stat.stock.pd.detail.query | stat_stock_pd_detail_query.php | 查询盘点盈亏统计 |
库存类 | wdt.stock.transfer.query | stock_transfer_query.php | 查询调拨单信息 |
库存类 | wdt.stockout.batch.detail | stockout_batch_detail.php | 查询出库类委外效期和批次信息 |
库存类 | wdt.stockin.batch.detail | stockin_batch_detail.php | 查询入库类委外效期和批次信息 |
库存类 | wdt.vip.stock.query.all | vip_stock_query_all.php | 全量查询库存 |
库存类 | wdt.vip.wms.stockinout.order.push | vip_wms_stockinout_order_push.php | 创建委外出入库单 |
库存类 | wdt.vip.stock.outside.wms.query | vip_stock_outside_wms_query.php | 查询委外出入库单 |
库存类 | wdt.vip.jit.return.stockin.order.query | vip_jit_return_stockin_order_query.php | 查询JIT退货入库单 |
库存类 | wdt.vip.jit.stockout.order.query | vip_jit_stockout_order_query.php | 查询JIT出库单 |
四、上线
将测试环境地址:http://hu3cgwt0tc.api.taobao.com/router/qmtest变更为正式环境地址:http://hu3cgwt0tc.api.taobao.com/router/qm