文档中心 > 商家经营工具-开发指引

奇门官方集成接入说明

更新时间：2024/07/31 访问次数：78565

一、说明
二、准备
三、接入
三、附录

一、说明

官方集成是阿里集团内部系统与外部系统对接方式，接入者在官方集成控制台完成API的接入即可完成相应服务的链路对接。

二、准备

1）跟小二确认该api是否属于官方集成场景，否则需要走官方场景来完成对接。

2）准备好联调的appkey，如果以前没有入住过开放平台或者没申请过appkey则需要申请，参考《新手指南》，另外也可以咨询与您对接的小二。

3）使用开放平台帐号登录接入后台，查看是否有对应的业务，如果没有请让小二添加。

三、接入

1. 开发接口

1）进入文档

① 找到对应业务，点击进入；

② 找到对应的api，点击开发文档，如图：

③ 文档会说明服务会接收到的参数以及服务需要响应的报文格式以及请求类型，开发者可以根据请求和响应报文做好开发工作。

2）开发接口

① 开发者可以根据上面的文档进行开发，开发后可以自己在本地执行测试，使用业务接收示例并往自己服务地址发送请求。

②响应示例可以参考成功响应示例。

接口验签

为了防止接口被人乱掉用，需要在服务端做验签的逻辑，校验请求的合法性。开发者要求使用验签算法来对请求合法性进行校验。服务端验签可以使用sdk提供的工具类SpiUtils，验签失败时候返回“验签失败回应示例”的内容即可，验签逻辑如下。SDK提供有java,c#,php,C,NodeJS版本，如果您不使用SDK，可以把该工具类拷贝到工程中；如果您使用的语言没有对应的SDK版本，可以参考附录的验签算法翻译成对应的语言。

注意！如果您是自己封装的签名算法，请求修改标准的签名算法，即使此时签名结果是正确的。

/**
* 使用该方法同时请务必要阅读该方法的源码，大致了解该方法的实现。
*
* 如果验签失败则需要返回验签失败的结果，并且需要和配置对应的上，系统才认为是验签成功；
* 
* 如果正确的请求老是误认为验签错误了，则确认以下几点：
* 1编码是否UTF8 
* 2密钥是否写错了，特别是沙箱和线上密钥别搞错
* 3request如果是json,xml类型（form不用理会）则确认inputstream是否被读取过了？如果需要使用body但不想改动麻烦，可以先执行验签，
* 然后在验签结果中获取body（checkResult.getRequestBody()方法）来执行业务逻辑
* 4上层框架是否有做封装导致参数变更
* 如果名以上几点检查没问题，请提供加签前的最终字符串给小二协助排查
*/
CheckResult result = SpiUtils.checkSign(request, targetAppSecret);  //这里执行验签逻辑
if(!result.isSuccess()) {  //如果验签失败则需要返回 验签失败的结果，并且需要和配置对应的上，系统才认为是验签成功
//按验签失败回应示例
}

2. 接口验收&API上线

当您完成服务开发后可以在点击接入开始执行服务的配置和验收，如图：

填写测试服务地址和正式服务地址（如果您此时还没有正式服务地址可以填写测试服务地址，等要上线时候返回来修改正式服务地址即可），点击下一步。

① 执行服务检测，需要完成服务要求的验收内容和检测内容，点击“查看结果”可以查看具体具体验收执行的内容，可以相应的执行修改。

② 当完成测试环境的验收时候，点击进入下一步，此时才可以进行测试环境的服务联调（测试环境没结束是无法测试联调的）。

③ 完成服务联调后可以执行正式环境服务验收，走完相同的流程后可以点击服务上线即可完成API上线。此时完成正式环境服务打通。

3. 变更升级

如果服务地址发生变化或者接口发生变化，点击变更升级并走完相应流程后可以完成API的变更。

三、附录

验签算法

参考文档《API调用方法详解》签名算法部分。

FAQ

关于此文档暂时还没有FAQ

有用(0) 我要提问

淘宝开放平台

商家经营工具-开发指引