2.3.1 请求头部详解
零信任aTrust设备的所有API接口调用都是通过HTTPS请求完成,在进行接口调用时,对HTTPS的请求头部有固定的格式和字段要求。即业务系统在调用零信任API接口时,请求头部必须携带签名(x-ca-sign)、API ID(x-ca-key)、时间戳(x-ca-timestamp)和随机数(x-ca-nonce)才可通过零信任服务的鉴权。
1、请求头部字段
字段 | 描述 |
---|---|
x-ca-sign | 签名,参考 2.3.2 签名计算详解。 示例: 5eec2b22d4ad87daac420d9ef1476346da46ecabbfb2ed18a744d571cdde7756 |
x-ca-key | API ID,参考 2.2.2 获取API ID和API 密钥 示例: 8165305 |
x-ca-timestamp | 时间戳为Unix时间戳格式,单位为秒,10位长度的正整数。 示例: 1629527100 |
x-ca-nonce | 随机数,由数字字母加中划线组成的字符串,长度2~128位,建议使用 uuidv4 生成。示例: f5f0fe63-5b3e-4e44-908c-b95758b6d7e4 |
2、API接口请求示例
- API原始请求:该请求无法直接完成零信任服务端的鉴权,需根据该请求进行签名计算后按要求插入HTTPS请求头部
POST https://1.1.1.1:4433/api/v1/admin/login?username=sf&password=123
content-type: application/json;charset=UTF-8
Request Payload
{
"status": 1,
"type": "test"
}
- API签名后最终请求:根据章节【2.3.2 签名计算详解】可知请求头需进行签名计算后按指定要求写入请求头部
POST https://1.1.1.1:4433/api/v1/admin/login?username=sf&password=123
x-ca-key: 8165305
x-ca-sign: 5eec2b22d4ad87daac420d9ef1476346da46ecabbfb2ed18a744d571cdde7756
x-ca-timestamp: 1629527100
x-ca-nonce: f5f0fe63-5b3e-4e44-908c-b95758b6d7e4
content-type: application/json;charset=UTF-8
Request Payload
{
"status": 1,
"type": "test"
}