本文档主要介绍调用有人云平台API的请求结构和请求示例。
请求URI
请求URI由如下部分组成。
{URI-scheme}://{Endpoint}/{resource-path}
例:https://openapi.mp.usr.cn/usrCloud/vn/dev/getDevs
参数 | 说明 |
---|---|
URI-scheme | 传输请求的协议,当前所有API均采用HTTPS协议。 |
Endpoint | 承载REST服务端点的服务器域名或IP和端口,有人云平台为 openapi.mp.usr.cn |
resource-path | 资源路径,即API访问路径。从具体API的URI信息处获取,例如获取设备列表接口的resource-path为“ /usrCloud/vn/dev/getDevs ”。 |
请求方法
HTTPS请求方法(也称为操作),它告诉服务你正在请求什么类型的操作。
方法 | 说明 |
---|---|
POST | 请求服务器新增资源或执行特殊操作。 |
GET | 请求服务器返回指定资源。 |
PUT | 请求服务器更新指定资源。 |
DELETE | 请求服务器删除指定资源,如删除对象等。 |
请求消息头
参数 | 是否必选 | 说明 |
---|---|---|
Content-Type | 必选 | 消息体的媒体类型,默认取值为“application/json”。 |
X-Access-Token | 除了获取X-Access-Token接口外 调用其他接口必选 | 调用有人云接口的访问凭证(注意:X-Access-Token 有效时间为2小时,两小时内可以重复使用,获取详情) |
请求消息体
请求消息体通常以结构化格式发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。
以获取设备详情为例,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,“** ”需要根据实际值填写。
{
"deviceId" : "********"
}