当前位置: 文档中心
奇门接入
注:对接奇门自定义API对接旺店通开放平台,可实现的功能相同,区别在于是与奇门云官网对接还是与旺店通开放平台对接。
1. 奇门自定义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 |
2. 奇门自定义API接入流程
2.1 申请奇门授权的appkey
前置要求:企业级支付宝账号。
第一步:注册淘宝开放平台开发者。(已注册客户跳过),注册指南地址:https://open.taobao.com/doc.htm?docId=103232&docType=1#
1)打开连接->右上角选择登录。
2)登录淘宝账号
第二步:注册奇门应用,注册地址
http://my.open.taobao.com/common/applyIsv.htm?appTag=133&accessCode=96A11209D311D275DA05937EAFFEDAC1
前置条件:企业资质的支付宝账号。
后续就是创建应用,然后等待小二申请。
2. 授权通过够,私聊将appkey提供给旺店通的技术人员(http://doc.wangdian.cn/?p=859&preview=true “奇门云网官对接说明”)
3. 根据奇门云网官对接说明文档,进行请求方式的改造。奇门请求需要设置白名单。如图,将ip地址加入白名单后才可以请求奇门。
4. 与旺店通联调。
2.2 对接方式描述:
为了完善和规范对接业务,api接口已经陆续的完成接口改造。具体完成情况,请看API说明的奇门自定义接口列表。
奇门角色介绍:奇门只是一个数据传输的通道,卖家只需要与奇门对接,将请求发送给奇门。奇门通过卖家请求参数中的目标appkey:target_app_key来锁定卖家目标请求的是旺店通,因此请求到旺店通接口。旺店通在通过奇门将数据返回给卖家。
2.3 数据传输描述:
2.4 奇门角色描述:
针对原始形式的接口,如果客户需要对接三个系统,那么需要开发三套对接逻辑。改造成奇门接口之后,只要开发一套对接奇门的逻辑,改变参数target_app_key就可以对接任意系统。(前提是,该系统支持奇门对接)
对于已经对接过api标准接口的客户来说,需要以下几步调整(新客户直接参考下面的对接说明即可):
1. 申请奇门授权的appkey和秘钥,并且提供appkey给旺店通技术人员。(申请流程见http://doc.wangdian.cn/2017/12/10/%e5%a5%87%e9%97%a8%e4%ba%91%e7%bd%91%e5%ae%98%e6%94%b9%e9%80%a0%e6%b5%81%e7%a8%8b/)
2. 在原来的请求参数基础上对应加上奇门的系统参数即可。(具体见下面的对接说明描述)
3. 奇门自定义采用统一入口形式,也就是说不同的接口请求的地址是相同的,而不同的接口是通过系统参数中的method来区分。(由于奇门接口有一定的命名规则,所以接口名称有对应的调整。比如,之前查询订单管理接口trade_query.php现在改为:method=wdt.trade.query,其他接口也做了相似的调整,具体可以查看对应的在线文档)
4. 签名的计算方式采用奇门的计算方式。请求方式依然是post请求。5. 返回值中的错误码为了避免与奇门返回值冲突,将code改为errorcode。
2.4 对接说明
奇门对接说明文档地址:http://open.taobao.com/docs/doc.htm?spm=a219a.7395905.0.0.vrJf9P&articleId=101617&docType=1&treeId=1
(1)条件:经过奇门授权分配的appkey,secretKey
(2)请求参数:
奇门系统参数:
'method'=>'wdt.trade.query' //方法名即接口名,格式为wdt.原接口名称('-'变成‘.’)例如:查询订单管理原来的名字为trade_query.php,现在改为wdt.trade.query 'app_key'=>'******' //奇门授权app_key(向奇门申请获得) 'target_app_key'=>'21363512' //目标app_key,固定为21363512 'format'=>'json' //请求数据格式,固定为json 'sign_method'=>'md5' //对接奇门sign计算方式,固定为md5 'secretKey'=>'***********************' //奇门授权秘钥(向奇门申请获得)
旺店通系统参数:
'sid'=>'apidev2' //卖家账号 'timestamp'=>date('Y-m-d H:i:s',time()) //时间戳 'sign'=>’****************’ //计算方式如下
旺店通业务参数:(按照文档填写即可)
'end_time'=>'2017-10-27 02:11:45', 'start_time'=>'2017-10-27 02:11:00', 'status'=>0, 'page_no'=>0, 'page_size'=>10,
(3)sign计算方式
** demo数据:**
$data=array( //奇门系统参数 'method'=>'wdt.trade.query', 'app_key'=>'*******', 'target_app_key'=>'21363512', 'format'=>'json', 'sign_method'=>'md5', 'secretKey'=>'ff34***************585a3', //接口系统参数 'sid'=>'apidev2', 'timestamp'=>date('Y-m-d H:i:s',time()), //订单查询接口业务数据 'end_time'=>'2017-10-27 02:11:45', 'start_time'=>'2017-10-27 02:11:00', 'status'=>0, 'page_no'=>0, 'page_size'=>10, 'trade_no'=>'JY201710270002',
1)对数组升序排序,结果如下:
$data=array( 'app_key'=>'28*****', 'end_time'=>'2017-10-27 02:11:45', 'format'=>'json', 'method'=>'wdt.trade.query', 'page_no'=>0, 'page_size'=>10, 'secretKey'=>'ff34**************2585a3', 'sid'=>'apidev2', 'sign_method'=>'md5', 'start_time'=>'2017-10-27 02:11:00', 'status'=>0, 'target_app_key'=>'21363512', 'timestamp'=>date('Y-m-d H:i:s',time()), 'trade_no'=>'JY201710270002', );
2)secretKey+’keyvalue’+secretKey, 结果如下:
$data=array( 'app_key'=>'28*****', 'end_time'=>'2017-10-27 02:11:45', 'format'=>'json', 'method'=>'wdt.trade.query', 'page_no'=>0, 'page_size'=>10, 'secretKey'=>'ff34**************2585a3', 'sid'=>'apidev2', 'sign_method'=>'md5', 'start_time'=>'2017-10-27 02:11:00', 'status'=>0, 'target_app_key'=>'21363512', 'timestamp'=>date('Y-m-d H:i:s',time()), 'trade_no'=>'JY201710270002', );
3)大写md5加密,结果如下:
md5(secretKey+’keyvalue’+secretKey) A88C125F415F1D02DA94F3B29AB06FF1
4)请求奇门地址:(所有接口请求同一地址,根据参数中的method来区分接口)
测试环境地址:http://hu3cgwt0tc.api.taobao.com/router/qmtest
正式环境地址:http://hu3cgwt0tc.api.taobao.com/router/qm
3.奇门自定义API列表
奇门接口名称(method) | 旺店通标准接口名称 | 接口描述 |
---|---|---|
wdt.trade.query | trade_query.php | 查询订单管理 |
wdt.goods.query | goods_query.php | 查询货品档案 |
wdt.refund.query | refund.query.php | 查询退换管理 |
wdt.stockin.order.query | stockin_order_query.php | 查询入库单管理 |
wdt.stockout.order.query.return | stockout_order_query_return.php | 查询采购退货出库单 |
wdt.stock.query | stock_query.php | 库存查询(分页查询 |
wdt.logistics.query | logistics_query.php | 查询物流档案 |
wdt.purchase.order.query | purchase_order_query.php | 查询采购单信息 |
wdt.stock.transfer.query | stock_transfer_query.php | 查询调拨单信息 |
wdt.purchase.return.query | purchase_return_query.php | 查询采购退货单 |
wdt.stockin.order.query.refund | stockin_order_query_refund.php | 查询退换入库单 |
wdt.stockin.order.query.purchase | stockin_order_query_purchase.php | 查询采购入库单 |
wdt.stockout.order.query | stockout_order_query.php | 查询出库单管理 |
wdt.stockout.order.query.trade | stockout_order_query_trade.php | 查询销售出库单 |
wdt.shop.query | shop.php | 查询店铺详细信息 |
wdt.purchase.provider.query | purchase_provider_query.php | 查询供应商信息 |
wdt.warehouse.query | warehouse_query.php | 查询仓库详情信息 |
wdt.stock.sync.by.pd | stock_sync_by_pd.php | 创建盘点开单 |
wdt.stockin.order.push | stockin_order_push.php | 创建其他入库 |
wdt.api.goodsspec.push | api_goodsspec_push.php | 创建平台货品 |
wdt.stockout.order.push | stockout_order_push.php | 创建其他出库 |
wdt.goods.push | goods_push.php | 创建货品档案 |
wdt.sales.refund.push | sales_refund_push.php | 创建原始退款单 |
wdt.purchase.order.push | purchase_order_push.php | 创建采购单 |
wdt.stockin.purchase.push | stockin_purchase_push.php | 创建采购入库单 |
wdt.purchase.return.push | purchase_return_push.php | 创建采购退货单 |
wdt.purchase.return.order.push | purchase_return_order_push.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 | 创建调拨入库单 |