文档中心 > 开发文档

奇门入驻配置

更新时间:2020/08/11 访问次数:8338

重申提醒:须完成前面的ReX开放平台入驻和应用创建。

开放平台出口IP介绍://open.taobao.com/announcement.htm?spm=a219a.7386653.0.0.STZ4py&source=search&docId=25365&docType=12

申请成功奇门开发者

如果之前没有操作过奇门的新账户,在登录后界面会提示“您不是奇门开发者” 此处需要登记下信息提交。(老用户忽略)

PS:仅是申请加入,录入联系人信息提交即可。最终会提示“已成为奇门开发者” 

如下图所示例:

然后就可以继续进行后面的官方场景关联了。

关联奇门官方场景

 注解:这里大家可能有疑惑,我为什么要关联官方场景,这个官方场景又是什么呢?

通俗点讲,手淘或ReX零售端 用户购买商品后要完成后续的支付或者会员卡信息查询及认证等工作, 这个时候 ReX应用系统就要通过奇门网关这个门户请求商家的ERP系统。

所以需要商家进行入驻关联相应场景,并配置和授权后,使用SDK在ERP端做好服务的开发工作,以达到信息的调用和访问。

 

进入官方服务场景页面

官方场景查看请进入:https://qimen.taobao.com/#/sceneManage/officialList?_k=fp1umh

进入奇门控制台(如果没有登录,则会跳转到登录页面,或许登录后发现进入了公共页面,可重新打开地址),关联场景如下图所示

  • PS说明:点击“官方服务”,可以看到当前已经关联的官方场景。
  • 如果之前没有关联过,则需要点击小蓝框“+关联官方场景”进行和应用之间的关联。

进行场景关联

说明:

对于官方场景,当前ReX平台开通了以下几种场景

五道口支付:用于支付相关的业务流程

wdk-会员管理:用于获取会员信息。

场景关联地址:https://qimen.taobao.com/#/sceneManage/relationOfficial?_k=j22vgr

 操作:1、下拉框选择官方场景,如“五道口支付” 选择后页面会自动加载场景信息。

         2、下拉框选择应用 如“XX应用”—这个就是商家前面创建的应用。

         3、填写商家入驻关联场景描述,内容随意方便好记就可以。

         4、检查信息无误,点击“确认提交”.------此时完成场景的关联。

操作如下图所示:

 

配置实现奇门接口

1.关联了官方场景之后,点击左侧“官方服务”可以看到当前已经关联的官方场景。

2.点击对应场景的右侧“管理”,去配置实现这个场景下的接口,如下图所示

也可通过如下链接进行:https://qimen.taobao.com/#/sceneManage/officialList?_k=olwgt6

 

 

请求地址配置(即商家ERP服务端地址)

这一步主要配置三方实现这个接口对外网可以访问的HTTP URL。奇门会请求这个URL,然后获取到结果。如下图所示(这个地址商家端要依赖SDK实现功能开发)

需要注意的点

*配置的URL,必须要外网可以访问。

*配置的URL中如果有参数的话,对于参数的key不能出现开放平台保留的参数key,比如:这个URL,http://www.example.com/payment?method=xxx。其中method这个参数是开放平台保留的参数key,不能出现在配置的URL中。具体哪些参数key是保留的可以看这里

//open.taobao.com/doc.htm?docId=101617&docType=1#s2

 

 

响应配置(即商家ERP的收到请求后的响应)

这里主要是说明三方对于返回结果的json格式需要是什么样的结构。这里举例alibaba.wdk.payment.pay接口为例,要求的返回结构和实际返回的数据如下图所示

注:因为是官方公共接口规范,不用进行页面二次配置,主要是让商家技术人员了解响应报文结构和参数,在做服务端开发时能够匹配。

 

 

接口文档预览

此页面主要是对当前API的各信息汇总展示,布局如下:

场景概要-----API所在官方场景说明

API概要-----当前API信息说明

请求demo---报文样例可用做后面的测试案例(数据按实际调整)

响应demo---正确响应的报文样例。

验签demo---验签失败返回的报文样例。

入参规范

出参规范

如下图所示:

 

 

自测环境

当前页面是用奇门提供的工具来测试商家ERP服务端自己的代码,以及返回是否是接口要求的格式,使用这个工具可以解耦开需要跟ReX平台开发同学一起联调的问题。如下图所示

需要注意的点

  • 这里最大的问题就是请求参数的配置,尤其是如果参数是一个复杂结构,需要填写json结构的参数时,会如果填写不正确,会出现参数校验错误的情况。对于简单结构的参数,按照类型填写即可,对于复杂结构,还请商家技术人员仔细check报文结构.
  • 这里的测试环境和正式环境分别对应前面填写的正式和测试的两个地址。
  • 注意!API没有发布之前无法选择正式环境,请选择测试环境。因为API还没上线,选择线上环境会提示ApiName不合法

    

 

 

 

正式发布

声明:入驻配置后,商家在奇门的接口配置未发布之前,奇门默认调用的是授权的测试地址;发布后默认调用的是授权的正式地址

        所以在测试环境联调未完成前,请商家尽量不要把奇门的入驻配置发布,否则就有可能测试数据调向商家生产环境。

测试完成之后就可以正式对外发布了。发布过程中还需要进行一些签名配置,具体的可以参考奇门官方的文档,点击这里访问

//open.taobao.com/doc.htm?docId=106849&docType=1#s0

注意:如果自测通过,则可以点击『自测通过请发起服务验证』,此时系统会发起非法请求请求服务后端,如果后端不满足验签逻辑则提示错误。具体验签逻辑参考上文。验证通过可以点击发布上线。

发布上线后,请在自测页面选择正式环境测试是否成功发布成功。

          

 

授权配置

 

在正式发布之后需要授权给ReX平台的appkey,允许ReX平台的appkey来调用你的服务。

ReX平台的appkey是:23773503。操作步骤如下图所示。

--因为ReX平台的内部系统是关联在这个应用APPKEY上的,所以只有商家授权后,ReX平台的系统才能通过奇门调用商家ERP。

如果实现的奇门接口在这里正式环境和测试环境都有了,那么就代表授权成功。

否则在实际调用中会出现无法找到路由的错误。

目录进入引导:云工作台-->左侧"业务系统构建&集成"-->奇门网关-->左侧“官方服务集成”-->然后在页面上找到已关联的“wdk-会员管理”--管理 --->左侧“授权配置

授权配置图例:

 

点击新增授权应用,输入ReX平台的appkey:23773503     (PS:授权说明自定义编写,建议“授权给ReX平台调用”)

检查是否配置正确,点击第二步中的 配置奇门授权 如下图:对正式环境和测试环境接口的地址配置

 最后选择配置奇门授权,同步所有官方场景到路由配置,或直接根据环境和API组合添加授权

 

 

FAQ

关于此文档暂时还没有FAQ
返回
顶部