当前位置: 文档中心

自研系统&三方系统接入奇门自定义场景

注:"奇门自定义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
卖家支付宝IDalipay_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 测试开发

  • SDK下载(含使用说明):奇门自定义sdk

  • 测试开发过程问题解决:点击“联系我们”查看入群方式,入群沟通相关问题。

  • 奇门自定义API与旺店通标准API参数对比说明。

请求地址:

接口环境 

旺店通标准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

wdt签名计算规则

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.queryshop.php查询店铺详细信息
基础类wdt.warehouse.querywarehouse_query.php查询仓库详情信息
基础类wdt.logistics.querylogistics.php查询物流档案
基础类wdt.purchase.provider.querypurchase_provider_query.php查询供应商信息
基础类wdt.purchase.provider.create      purchase_provider_create.php创建供应商信息
货品类wdt.goods.pushgoods_push.php创建货品档案
货品类wdt.goods.querygoods_query.php查询货品档案
货品类wdt.api.goodsspec.pushapi_goodsspec_push.php创建平台货品
货品类wdt.vip.api.goods.queryvip_api_goods_query.php查询平台货品
货品类wdt.suites.query       suites_query.php查询组合装货品
货品类wdt.suites.pushsuites_push.php创建组合装
货品类wdt.goods.brand.querygoods_brand_query.php查询货品品牌
货品类wdt.goods.class.querygoods_class_query.php查询货品分类
订单类wdt.trade.push       trade_push.php创建原始订单
订单类wdt.trade.querytrade_query.php查询订单管理
订单类wdt.stockout.order.query.tradestockout_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.modifyvip_trade_modify.php修改订单标记
订单类wdt.vip.stat.sales.by.spec.shop.warehouse.queryvip_stat_sales_by_spec_shop_warehouse_query.php查询销售汇总
订单类wdt.fa.api.account.detail.queryfa_api_account_detail_query.php查询平台账单
订单类wdt.vip.api.trade.queryvip_api_trade_query.php查询原始订单
订单类wdt.vip.trade.batch.modifyvip_trade_batch_modify.php批量修改订单标记
订单类wdt.fa.alipay.account.check.queryfa_alipay_account_check_query.php查询平台对账
售后类wdt.sales.refund.pushsales_refund_push.php创建原始退款单
售后类wdt.stockin.refund.push          stockin_refund_push.php创建退货入库单
售后类wdt.refund.queryrefund_query.php查询退换管理
售后类wdt.stockin.order.query.refundstockin_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.queryvip_api_refund_query.php查询原始退款单
售后类wdt.stockin.pre.order.querystockin_pre_order_query.php查询退货预入库单
采购类wdt.purchase.order.pushpurchase_order_push.php创建采购单
采购类wdt.stockin.purchase.pushstockin_purchase_push.php创建采购入库单
采购类wdt.purchase.order.querypurchase_order_query.php查询采购单信息
采购类wdt.purchase.apply.querypurchase_apply_query.php查询采购申请单
采购类wdt.stockin.order.query.purchasestockin_order_query_purchase.php查询采购入库单
采购类wdt.purchase.return.pushpurchase_return_push.php创建采购退货单
采购类wdt.purchase.return.order.pushpurchase_return_order_push.php创建采购退货出库单
采购类wdt.purchase.return.querypurchase_return_query.php查询采购退货单
采购类wdt.stockout.order.query.returnstockout_order_query_return.php查询采购退货出库单
采购类wdt.purchase.apply.pushpurchase_apply_push.php创建采购申请单
采购类wdt.purchase.apply.querypurchase_apply_query.php查询采购申请单
采购类wdt.purchase.order.endpurchase_order_end.php取消采购单
采购类wdt.purchase.return.endpurchase_return_end.php取消采购退货单
采购类wdt.purchase.order.end.wmspurchase_order_end_wms.php取消委外采购单
库存类wdt.stock.querystock_query.php增量查询库存
库存类wdt.stock.sync.by.pdstock_sync_by_pd.php创建盘点开单
库存类wdt.stock.pd.order.query        stock_pd_order_query.php查询盘点单
库存类wdt.stockin.order.pushstockin_order_push.php创建其他入库
库存类wdt.stockin.order.querystockin_order_query.php查询入库单管理
库存类wdt.stockout.order.pushstockout_order_push.php创建其他出库单
库存类wdt.stockout.order.querystockout_order_query.php查询出库单管理
库存类wdt.stock.transfer.pushstock_transfer_push.php建调拨单
库存类wdt.stockout.transfer.pushstockout_transfer_push.php创建调拨出库单
库存类wdt.stockin.transfer.pushstockin_transfer_push.php创建调拨入库单
库存类wdt.stat.stock.pd.detail.querystat_stock_pd_detail_query.php查询盘点盈亏统计
库存类wdt.stock.transfer.querystock_transfer_query.php查询调拨单信息
库存类wdt.stockout.batch.detailstockout_batch_detail.php查询出库类委外效期和批次信息
库存类wdt.stockin.batch.detailstockin_batch_detail.php查询入库类委外效期和批次信息
库存类wdt.vip.stock.query.allvip_stock_query_all.php全量查询库存
库存类wdt.vip.wms.stockinout.order.pushvip_wms_stockinout_order_push.php
创建委外出入库单
库存类wdt.vip.stock.outside.wms.queryvip_stock_outside_wms_query.php查询委外出入库单
库存类wdt.vip.jit.return.stockin.order.queryvip_jit_return_stockin_order_query.php查询JIT退货入库单
库存类wdt.vip.jit.stockout.order.queryvip_jit_stockout_order_query.php查询JIT出库单


四、上线