通用参数#
为了满足多样化的应用场景,特赞开放平台提供了丰富的 API 和事件,供开发者调用或订阅。这些 API 和事件会涉及到一些通用参数,在此进行统一介绍。通用参数可能作为请求参数,也可能作为响应参数。在使用特赞开放平台提供的 API 和事件之前,建议先了解一下这些通用参数的含义。
应用相关#
client_id
是特赞开放平台应用的唯一标识。在创建应用时,由系统自动生成,用户不能自行修改。client_key
是应用的秘钥。在创建应用时,由系统自动生成,在调用某些 API 时,需要将 app_secret 作为请求参数之一。企业相关#
tenant_id
是租户唯一标识,在实际应用场景中,对应一个企业。访问凭证#
为了提升 API 调用的安全性,特赞开放平台设计了访问凭证机制。在调用接口前,需要先获取所需的访问凭证。访问凭证我们也称为 access_token。访问凭证代表应用从平台、租户(公司或者团队)、用户手中获取的授权。
应用访问凭证,参数名为 : access_token
开放环境#
请求参数#
请求头Key | 请求头Value | 请求头描述 |
---|
Content-Type | application/json | 请求头的内容类型 |
Access-token | 获取访问令牌接口中的 access_token | 服务端API的验签token |
Token-type | 获取访问令牌接口中的 token_type | 接口验证类型,默认为bearer |
x-asm-prefer-tag | 指定测试环境 | 开放接口有多套测试环境,可咨询开发传指定测试环境值 |
请求体键 | 请求体类型 | 是否必须 | 描述 |
---|
param | JSON | N | 统一请求体包装 |
{
"token": "yourAccessToken",
"param": {}
}
响应体健 | 响应体类型 | 是否必须 | 描述 |
---|
code | String | Y | 业务响应码 |
message | String | Y | 业务响应信息 |
result | JSON | N | 业务响应体 |
{
"code": "0",
"message": "success",
"result": {}
}