本平台接口均为RESTful API
请求URI
请求URI由如下部分组成：
{Scheme}://{Endpoint}/{resource-path}?{query-string}
| 参数 | 描述 |
|---|---|
| Scheme | 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 |
| Endpoint | cloud-api.mandao.com |
| resource-path | 资源路径，也即API访问路径。从具体API的URI模块获取，例如“登录”API的resource-path为“/apis/token/v1/tokens”。 |
| query-string | 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，多个参数用“&”连接，例如“?limit=10&name=test”，表示查询不超过10条数据。 |
URI示意图：
为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。
https://cloud-api.mandao.com/apis/token/v1/tokens
请求方法
HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。
| 方法 | 说明 |
|---|---|
| GET | 请求服务器返回指定资源。 |
| POST | 请求服务器新增资源或执行特殊操作。 |
| PUT | 请求服务器更新指定资源。 |
| PATCH | 请求服务器更新资源的部分内容。 |
| DELETE | 请求服务器删除指定资源，如删除对象等。 |
示例：
请求消息头
| 名称 | 描述 | 是否必选 | 示例 |
|---|---|---|---|
| Content-Type | 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 | 是 | application/json |
| token | 用户Token。 用户Token也就是调用登录接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应体（Body）中包含的“token”的值即为Token值。 |
否 使用Token认证时该字段必选。 |
0194c05d78634b21ba87a447b3cbde39 |
| userId | 用户ID。 用户ID也就是调用登录接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应体（Body）中包含的“userId”的值即为UserId值。 |
否 使用Token认证时该字段必选。 |
2019011500000061 |
示例：
POST https://cloud-api.mandao.com/apis/token/v1/tokens
Content-Type: application/json
请求消息体（可选）
该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定
示例：
POST https://cloud-api.mandao.com/apis/token/v1/tokens
Content-Type: application/json
{
“username”: “137*****831”,
“password”: “******“
}
作者：叶奕珺 创建时间：2024-08-03 08:47
最后编辑：叶奕珺 更新时间：2025-04-29 18:46
最后编辑：叶奕珺 更新时间：2025-04-29 18:46
