Skip to main content

1. 申请安全凭证

在第一次使用 API 之前,请申请安全凭证。安全凭证包括 ApiKey 和 ApiSecret:
  • ApiKey 用于标识 API 调用者身份
  • ApiSecret 用于加密签名字符串和服务器端验证签名字符串的密钥
用户必须严格保管安全凭证,避免泄露。每个账号最多可以拥有一对 ApiKey / ApiSecret。

2. 生成签名串

有了安全凭证 ApiKey 和 ApiSecret 后,就可以生成签名串了。 假设用户的 ApiKey 和 ApiSecret 分别是:
  • ApiKey: 11519269-5e35-****-****-09e355e00f77
  • ApiSecret: 0CDE6743F18F3DA********49FD47C1576671FD5
这里只是示例,请根据用户实际申请的 ApiKey 和 ApiSecret 进行后续操作。
请求头(Request Header) 请求参数如下:
1

对参数排序

对所有请求参数按参数名的字典序(ASCII 码)升序排序。只按参数名进行排序,参数值保持对应即可。按 ASCII 码比大小,如 InstanceIds.2 要排在 InstanceIds.12 后面。
2

拼接请求字符串

将排序好的请求参数格式化成 参数名称=参数值 的形式,然后用 & 拼接在一起。
参数值为原始值而非 URL 编码后的值。
3

拼接签名原文字符串

签名原文串的拼接规则为:请求方法 + 请求主机 + 请求路径 + ? + 请求字符串 + 时间戳
4

生成签名串

使用 HMAC-SHA1 算法对签名原文字符串进行签名,然后将生成的签名串使用 Base64 进行编码。
最终得到的签名串为:

3. 发起请求

生成的签名串放置在请求头(Request Header)中,参数名为 FP-SIGN

4. 签名失败

根据实际情况,存在以下签名失败的错误码,请根据实际情况处理。