公共请求参数¶
公共参数是每次调用 API 时均需携带的参数,用于标识请求身份与请求格式。如无特殊说明,各接口文档的「输入参数」中不再重复展开这些参数的完整说明,但发起请求时仍须携带,否则无法正常调用。
公共请求头¶
公共参数统一通过 HTTP Header 传递,如下表所示:
| 参数名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Authorization | String | 是 | HTTP 标准身份认证头部。格式:Bearer {access_token},其中 access_token 由 密钥鉴权 接口换取。示例值: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx |
| Content-Type | String | 是 | 请求体格式。使用 JSON 请求体时固定为 application/json。示例值: application/json |
请求结构示例¶
假设登录域名为 {登录域名},调用某个 POST JSON 接口时,请求结构示例如下:
POST /prod-api/{接口路径} HTTP/1.1
Host: {登录域名}
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx
Content-Type: application/json
{请求体 JSON}
cURL 示例:
curl -X POST 'https://{登录域名}/prod-api/{接口路径}' \
-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx' \
-H 'Content-Type: application/json' \
-d '{请求体 JSON}'
说明:GET 等无请求体的接口仍须携带
Authorization;是否需要Content-Type以具体接口说明为准。