公共参数
2024.08.16 12:40:55
公共参数是用于标识产品和接口鉴权目的的参数,如非必要,在每个接口单独的接口文档中不再对这些参数进行说明,每次请求均需要携带这些参数。
请求公共参数
参数名称 | 类型 | 是否必选 | 最大长度 | 描述 |
---|---|---|---|---|
secretId | String | Y | 32 | 产品秘钥 id ,由易盾内容安全服务分配,产品标识 |
businessId | String | Y | 32 | 业务id ,由易盾内容安全服务分配,业务标识 |
timestamp | Number | Y | 13 | 请求当前 UNIX 时间戳,请注意服务器时间是否同步 |
nonce | Number | Y | 11 | 随机整数,与 timestamp 联合起来,用于防止重放攻击 |
signatureMethod | String | N | 指定传参 | 指定签名算法,国密:SM3,如果使用md5默认签名算法,可以不传 |
signature | String | Y | 32 | 请求签名,用来验证此次请求的合法性,具体算法见 接口鉴权 |
响应通用字段
所有接口响应值采用 json 格式, 如无特殊说明,每次请求的返回值中,都包含下面字段:
参数名称 | 类型 | 描述 |
---|---|---|
code | Number | 接口调用状态,200:正常,其他值:调用出错,返回码见 响应返回码 |
msg | String | 结果说明,如果接口调用出错,那么返回错误描述,成功返回 ok |
result | 数组 | 接口返回结果,各个接口自定义,若为空标识返回正常 |