平台接口说明
接入方式
平台与应用间采用基于 JSON 的 HTTP 接口进行交互。
接口的使用方应做如下约定：
- 云平台将严格校验请求参数，若参数与接口规范不一致，接口调用将失败
- 云平台未来将扩展接口功能时可能会增加接口应答返回时的参数数量。接口使用方应能对此兼容。
- 业务方生产环境回调的接口约定必须使用 HTTPS 协议（第三方机构颁发的正式 SSL 证书）。
- 芯相随云平台与业务云平台的接口交互使用 JSON 的方式 ，即
Content-Type: application/json;charset=utf-8。
接入地址
- 联调环境访问地址：需线下邮件申请。
- 生产环境访问地址：需线下邮件申请。
接口文档
- 芯相随云平台提供的 HTTP API 文档在 : Open API
- 需要业务平台实现的 HTTP API 文档在 : WebHook API
公共字段
公共字段说明了每个请求、应答应包含的公共字段。除特殊情况外，这些字段不在具体业务接口报文定义中重复说明。
请求参数
| 参数名 | 类型 | 位 置 | 是否必填 | 说明 |
|---|---|---|---|---|
| access_token | String | Url | 获取 access_token 接口外均为必填项 | 请求令牌( 第三方平台请求获取 token 接口获取)，有效时间为 2 个小时 |
响应参数
Response Body
{
"code": 0,
"msg": "success"
}
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | string | 返回码，详见 错误码定义 |
| msg | string | 返回信息 |
安全策略
芯相随云平台采用 OAuth 2.0 标准中的 Client Credential 方式，客户端通过云平台预先颁发的用户名和密码进行认证，认证通过后云平台将颁发非永久性用户令牌，使用该令牌可访问云平台后续开发的接口。
第三方平台提交 appid 和 secret（目前这两个字段由芯相随方通过邮件或线下方式发送给第三方），芯相随云平台校验通过后会颁发 32 位 access_token，后续请求都要求在请求中带上 access_token，access_token 的有效时间为 2 小时（暂定，以实际接口返回的 expire_in 字段为准），超过该时间需要重新获取。
同时，第三方平台需提供接口供芯相随云平台调用，通过第三方平台分配给芯相随云平台的 appid 和 secret 获取 access_token，芯相随云平台将在后续对第三方平台的请求中携带 access_token，供第三方平台验证请求的合法性。
access_token 的有效时间为 2 小时（以实际的 expire_in 字段为准），超过该时间需要重新获取。