当前位置: 文档中心

线上ERP-CRM奇门接口


一、接入价值&背景


   1.1 接入价值


  • 获取旺店通ERP客户端淘系平台单据数据(包含敏感信息)。

   1.2 接入背景
  • 根据阿里巴巴—电商服务市场于2015年8月18日发布的《服务市场应用间敏感数据互通安全规则公告》,所有调用订单信息相关类目的应用,必须通过“奇门”和”云栈菜鸟电子面单”安全通道实现订单敏感信息在OMS、ERP、WMS、TMS等第三系统间的流转,并于2016年1月31日前完成新老用户的整改迁移。奇门ERP—CRM场景应运而生,主要应用于接入方商家的CRM(会员管理系统),获取旺店通ERP内各个平台(含淘系)销售订单数据(含隐私数据)。

  • 附:服务市场应用间敏感数据互通安全规则公告:https://open.taobao.com/doc.htm?docId=103499&docType=1


二、接入条件


  • 已经完成文档三方系统奇门appkey申请或自研系统奇门appkey申请步骤。

  • 奇门应用已经发布且该应用符合如下标签:服务商后台系统,客户关系管理,全渠道ERP,ERP软件,奇门-线下CRM,奇门-商家自研线下系统


三、接入流程


    3.1 点击以下链接登录:奇门控制台

    


    3.2 选择奇门中心—>三方互通—>场景列表,选择接入线上ERP-CRM奇门接口场景(注意:不要选择为ERP-CRM官方场景)

    

   3.3 选择接入场景的应用,如选择不到相关应用,说明应用未发布或应用不符合该场景标签,请参考文档第二条“接入条件”,填写关联原因,申请接入。

    

    

四、申请与旺店通ERP联调


    如果是奇门ERP-CRM场景、奇门自定义场景如下步骤申请联调,联调协助方式:点击“联系我们”查看入群方式,入群沟通联调相关事项。

    4.1 商家方登录开放平台:在“自助对接”—“奇门自助指南”中,根据指引步骤进行联调申请操作:

    


    4.2 收到联调上线邮件后,旺店通发起联调,商家同意联调,同意联调操作具体如下,请求必须参数旺店通ERPappkey:21363512,此appkey作为请求奇门接口的target_app_key。

  • 同意联调:三方互通->我的场景->线上ERP-CRM奇门接口 选择第二页最后一个接口qimen.taobao.crm.order.detail.get接入。然后点击联调,如收到申请,点击‘通过’ ,并维护上可访问的服务地址。确定保存即可

  • 联调域名:http://qimen.api.taobao.com/top/router/qmtest

    

    


五、测试开发


    为开发者更高效的完成奇门ERP-CRM场景联调,可按照如下流程进行测试开发:


    5.1 进行session授权session为接口调用的必要信息,如进行奇门ERP-CRM场景联调,需先进行session授权,授权方式如下:

  • 点击链接,进入用户授权工具输入appkey,点击“去登录授权”,授权成功后界面会出现session相关信息。(session有效期,一般为30天,失效后需重新登录授权

    


    5.2 SKD下载:可在奇门控制台中下载,路径:"应用管理"→"管理"→"SDK下载"。

    


    5.3 奇门接口参数说明:

    请求地址:

        接口环境(url) 
奇门ERP-CRM场景
      测试地址      
http://qimen.api.taobao.com/router/qmtest
正式地址
http://qimen.api.taobao.com/router/qm

    接口名: 

接口名称(method)
                         奇门ERP-CRM场景                 
      测试地址      
taobao.crm.order.detail.get
正式地址
taobao.crm.order.detail.get

    公共参数:

字段名称
字段描述
字段示例
app_key奇门授权应用
213XXXX
methodAPI接口名称,同上面接口名说明(固定值)taobao.crm.order.detail.get
target_app_key目标appkey
由旺店通提供
sign_method签名的摘要算法,可选值为:hmac,md5,hmac-sha256md5
signAPI输入参数签名结果,签名算法介绍请点击这里XXXXXXXXXX
session用户登录授权成功后,TOP颁发给应用的授权信息,详细介绍请点击这里XXXXXXXXXX
timestamp时间戳,格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8。淘宝API服务端允许客户端请求最大时间误差为10分钟2015-01-01 12:00:00
format响应格式(固定值)json
vAPI协议版本(固定值)2.0

    业务参数:

字段名称
是否必传
字段描述
字段示例
startModified
查询起始时间(不起作用)

2011-11-11 08:00:00

endModified
查询结束时间(不起作用)

2011-12-11 08:00:00

pageNo
页码: 取值范围:大于零的整数; 默认值:1(不起作用)1
pageSize

每页条数。取值范围:大于零的整数; 默认值:20;最大值:100(不起作用)

20
sd_code
可不传XXXXXXXXXX
fields
order_id,order_sn,extendProps(固定值)order_id,order_sn,extendProps
extendProps

将旺店通原接口的业务参数,以json字符串的形式放到请求参数的扩展字段extendProps中。旺店通appkey,Sign,timestemp无需填写

注意:旺店通从该拓展字段解析参数,所以上面业务参数中的时间和分页相关字段,不生效,需将原旺店通接口相关参数传入该字段

wdt_interface字段说明:可传四个值,"stockout"(查询销售出库单),"trade"(查询订单管理),"stockin"(查询退货入库单),"refund"(查询退换单)

{"sid":"apidevnew2","wdt_interface":"trade","start_time":"2019-07-03 00:00:00","end_time":"2019-07-04 00:00:00","page_no":0,"page_size":50}

customerid测试环境可不传,正式环境必传
路由参数,上线生产环境时,自定义维护信息apidevnew2

    

   

五、申请上线

  • 点击“上线”进入上线配置页面

  • 点击上线申请进行线上授权申请,目前只支持部分角色发起,如果您没有该按钮,请联系旺店通方发起申请