公共参数
公共参数是用于标识用户和接口签名的参数,如非必要,在每个接口单独的文档中不再对这些参数进行说明,但每次请求均需要携带这些参数,才能正常发起请求。
使用签名方法的公共参数
使用签名方法时,公共参数需要统一放到 HTTP Header 请求头部中,如下表所示:
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ClientID | String | 是 | 客户端ID。 |
SignatureMethod | String | 是 | 签名加密方式,当前仅支持 HmacSHA256 方式。 |
Nonce | String | 是 | 随机字符串,方式重放攻击。 |
Timestamp | Int | 是 | 当前 UNIX 时间戳,可记录发起 API 请求的时间。例如:1716085926,如果与当前时间相差过大,会引起签名过期错误。 |
Signature | String | 是 | 请求签名,用来验证此次请求的合法性,需要用户根据实际的输入参数计算得出。具体计算方法参见签名方式文档。 |
请求结构示例
curl --location --request GET 'https://www.idcd.com/api/test' \
--header 'ClientID: df77f2de-2924-4499-adda-1c4cc243625a' \
--header 'Nonce: v0j38hHHUEqFwoh0Gc8Rbfi737xtIpLL' \
--header 'Timestamp: 1716085926' \
--header 'Signature: 624eef34b453ac74ae5109a921d20959cc066a674346277a29c92230ae7f5991' \
--header 'SignatureMethod: HmacSHA256' \