关于使用伙伴中心服务的说明

伙伴中心为开发应用提供免费测试接口调用。生产应用需要购买产品服务并获取orderKey 后调用调用api接口

基本术语

appKey / appSecret

App Key / App Secret ，开发者每创建一个应用(App)后平台都会自动分配一个 App Key 和 App Secret。App Key 是应用身份唯一标识，每个接口调用都要携带。App secret是私钥，用于对请求参数的数据签名，开发者需要妥善保存不得泄露！每一个 App 对应一套 App Key / App Secret

orderKey

OrderKey,开发者下单付款后，会分配一个orderKey，这是调用生产api必备参数，用于识别订单相关信息和订单有效期的唯一凭证，续订订单orderKey不变。开发应用调用api，orderKey可不填。

开发环境

方便开发者进行集成开发和测试的环境，与生产环境功能相同，两者间数据隔离，避免开发环境数据和线上生产环境数据互相冲突，提供独立的 App Key /App Secret。用户注册成功后，伙伴中心后台默认为用户创建一个开发环境。

生产环境

数据接口调用真正运营的商业环境。与开发环境间数据隔离，避免开发环境数据和线上生产环境数据互相冲突。提供独立的 App Key / App Secret ，在生产环境使用前请务必由开发环境切换到生产环境

查看您的API密钥

当你在使用开发应用或创建生产应用后，即可在应用详情中查看该 API 产品的密钥。 每组密钥由“公钥”和“私钥”组成，例如：

• 公钥 f38ce0b4-d08e-4653-8fcc-df7c53e77d5f

• 私钥 365632118e8138d523172329b153f628

伙伴中心API 安全验证方式：

1. “公钥 + 私钥” 签名验证方式

“公钥 + 私钥” 验证方式更加安全。请求地址中只包含你的“公钥”以及用你的“私钥”制作的签名，因此不会在请求地址中泄露你的私钥。具体使用方式请查看下一章如何使用签名验证方式。

使用签名验证方式

平台采用"appKey+ 私钥"的验证方式

“appKey+ 私钥” 验证方式更加安全。请求地址中只包含你的“appKey”以及用你的“私钥”制作的签名，因此不会在请求地址中泄露你的私钥。

签名指的是通过散列算法（目前为MD5)，对请求参数加密后得到的签名字串进行身份验证，避免了将“私钥”明文包含在请求中而造成泄露。

签名的生成方式如下：

1.构造验证参数字符串

将请求参数按照参数名字典升序排列后，把所有参数 param=value 用 & 连接起来，类似 URI 中 QueryString 的构造方式。目前支持的参数有：UNIX 时间timestamp（单位为秒，转换成字符串长度为 10 位，不要用毫秒值）和appKey。 例：appKey=1803e8fd-e303-4b73-a2da-96c4f4e892ec&b=2&c=3&timestamp=1443079775

2.使用 MD5 方式，以 API 密钥中的“私钥”对上一步生成的参数字符串进行加密, 得到签名 signature，例如秘钥为 secret_key_123， 则需要该秘钥追加到将上一步拼接好的字符串后面 appid=1803e8fd-e303-4b73-a2da-96c4f4e892ec&b=2&c=3&timestamp=1443079775secret_key_123

生成的md5值即为签名

50a057c4c611b5fbc3605036a1a1122d

md5生成的签名为32位全小写字符串

3.将上一步生成的签名和其他参数一并发送至服务端即可。

如 GET /some_api?appKey=1803e8fd-e303-4b73-a2da-96c4f4e892ec&b=2&c=3&timestamp=1443079775&signature=50a057c4c611b5fbc3605036a1a1122d

生成的签名有效期为5分钟内有效，超过5分钟请求会被拒绝

白名单使用说明

创建app后，可以在app详情页面看到白名单添加选项，添加可以调用接口的合法IP地址。添加白名单的ip地址可以正常调用api，否则不能调用。

API返回错误代码说明

HTTP状态码

业务返回码