公共参数

最近更新时间：2023-06-29 10:46:32 前往 Coding 编辑

公共参数是用于标识用户和接口签名的参数，如非必要，在每个接口单独的文档中不再对这些参数进行说明，但每次请求均需要携带这些参数，才能正常发起请求。

公共参数的具体内容会因您使用的签名方法版本不同而有所差异。

使用签名方法的公共参数

使用签名方法时，公共参数需要统一放到 HTTP Header 请求头部中，如下表所示：

参数名称	类型	必选	描述
X-NC-Timestamp	Integer	是	当前 UNIX 时间戳，可记录发起 API 请求的时间。例如 1529223702。注意：如果与服务器时间相差超过5分钟，会引起签名过期错误。
Authorization	String	是	HTTP 标准身份认证头部字段，例如： 2a1c6b3d1690520da1abe41da12dfabaf2c1574892b6ff7927629d7a0b11cdfc 计算过程详见签名方法。
X-NC-SecretId	String	是	需要携带在系统申请的SecretId信息
X-NC-Nonce	String	是	当前请求的唯一字符串，建议使用uuid当做nonce的值

假设用户想要请求某个接口获取数据，则其请求结构按照请求 URL、请求头部、请求体示例如下:

HTTP GET 请求结构示例:

https://winner-api.neunit.com:18053/cloud/asr/v1/xxx?xxx=xxx

Authorization: 2a1c6b3d1690520da1abe41da12dfabaf2c1574892b6ff7927629d7a0b11cdfc
Host: winner-api.neunit.com:18053
X-NC-SecretId: 2a1c6b3d1690520da1
X-NC-Nonce: e4c1ddd6-7186-41f8-9a3d-6599eb95ad87
X-NC-Timestamp: 1539084154

HTTP POST （application/json）请求结构示例：

https://winner-api.neunit.com:18053/cloud/asr/v1/xxx

Authorization: 2a1c6b3d1690520da1abe41da12dfabaf2c1574892b6ff7927629d7a0b11cdfc
Content-Type: application/json
Host: winner-api.neunit.com:18053
X-NC-SecretId: 2a1c6b3d1690520da1
X-NC-Nonce: e4c1ddd6-7186-41f8-9a3d-6599eb95ad87
X-NC-Timestamp: 1539084154

{
    "xxx":"xxx",
    ...
}