请求结构

更新时间：2024-09-10 01:49:13

本文为您介绍 API 请求中的请求方法、接入地址和请求头参数。

请求方法

支持以下 API 请求方法：

方法	说明
GET	请求服务器返回指定资源
PUT	请求服务器更新指定资源
POST	请求服务器执行特定操作
DELETE	请求服务器指定删除资源

当请求方法为 POST 时，Content-Type 参数值为 application/json。

接入地址

请根据设备所在私有云环境选择接入地址。

请求头参数

以下是调用 API 接口时的常用请求头（Request header）参数，请务必在请求头中加入必填的参数。

参数名	类型	参数位置	必填	说明
client_id	String	header	是	用户 ID。
sign	String	header	是	采用指定签名算法计算出的签名。
sign_method	String	header	是	签名的摘要算法，固定为 `HMAC-SHA256`。
t	Long	header	是	13 位标准时间戳。
access_token	String	header	是	Token 信息。说明：获取和刷新 Token 接口不需要此参数。
lang	String	header	否	语言类型。中国区默认 `zh` 其他区默认 `en`
nonce	String	header	否	API 调用者生成的 UUID。
Signature-Headers	String	header	否	开发者自定义需要加入签名的 header 字段。

请求示例

以 获取用户列表 API 为例，按照 50 条分页，获取从 2021-05-01 00:00:00 到 2021-05-15 00:00:00 ，第 1 页的用户列表信息的请求如下：

API 请求

GET:https://${hosts}/v2.0/apps/schema/users?page_no=1&page_size=50&start_time=1619798400&end_time=1621008000

请求头

client_id: 1KAD46OrT9HafiKd****
sign: C5EFD19AD45E33A060C0BE47AEF65D975D54B2D70CBAA7A1ACA1A7D0E5C0****
sign_method: HMAC-SHA256
t: 1588925778000
access_token: 3f4eda2bdec17232f67c0b188af3****
nonce: 5138cc3a9033d69856923fd07b49****
Signature-Headers: area_id:request_id
area_id: 29a33e8796834b1**** // 用户自定义
request_id: 8afdb70ab2ed11eb85290242ac13****// 用户自定义

上一篇使用 API

下一篇授权方式