功能说明
用于为指定 app 新增连接签名密钥。
支持批量提交 sign_keys,服务端最终最多保留 3 个 key,后加入的 key 排在前面。
接口说明
- Method:
POST - Path:
/apps/connectsignkeys/add
请求说明
请求鉴权:接口需要校验 Header,请查看 鉴权说明
请求 Header 定义
| 参数 | 数据类型 | 是否必填 | 参数说明 | |
|---|---|---|---|---|
| x-appkey | string | 是 | 应用 appkey | |
| x-nonce | string | 是 | 随机字符串,建议每次请求唯一 | |
| x-timestamp | string | 是 | 毫秒时间戳字符串,参与签名计算 | |
| x-signature | string | 是 | 签名值,计算规则见下方“签名计算伪代码” | |
| Content-Type | string | 是 | 固定为 application/json | |
| x-request-id | string | 否 | 请求唯一 id,不传则服务端自动生成 |
签名计算伪代码
input:
signKey
nonce
timestamp
payload = nonce + timestamp + signKey
signature = hex_encode(HMAC_SHA256(payload, key=signKey))
客户端对接按单个
signKey计算即可:signature = hex(HMAC-SHA256(nonce + timestamp + signKey, signKey))。
请求参数
| 参数 | 数据类型 | 是否必填 | 参数说明 | |
|---|---|---|---|---|
| sign_keys | array\<string> | 是 | 签名密钥数组,支持批量提交 |
请求示例
POST /apigateway/apps/connectsignkeys/add HTTP/1.1
x-appkey: appkey
x-signature: 2e639ae3600a4sdff61fb88b76f485b
x-nonce: nonce
x-timestamp: 1672568121910
Content-Type: application/json
{
"sign_keys": [
"sign_key_1",
"sign_key_2"
]
}
响应示例
{
"code": 0
}