
# 构造请求
本节介绍REST API请求的组成，并以调用[生成Token](https://support.huaweicloud.com/api-ocsmartcampus/ocsmartcampus_06_0008.html)接口说明如何调用API，该API获取用户的Token，Token可以用于调用其他API时鉴权。
#### 请求URI
请求URI由如下部分组成。
**{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}**
尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。
- **URI-scheme** ：表示用于传输请求的协议，当前所有API均采用**HTTPS**协议。
- **Endpoint**：指定承载REST服务端点的服务器域名或IP，不同环境的Endpoint不同，请在系统设置中查看Endpoint信息。
- **resource-path** ：资源路径，也即API访问路径。从具体API的URI模块获取，例如"[生成Token](https://support.huaweicloud.com/api-ocsmartcampus/ocsmartcampus_06_0008.html)"API的resource-path为"/v1/iotfm/auth/tokens"。
- **query-string**：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个"？"，形式为"参数名=参数取值"，例如"limit=10"，表示查询不超过10条数据。
例如您需要获取共享版实例的Token，则需使用"共享版"实例的Endpoint（xxx.com），并在[生成Token](https://support.huaweicloud.com/api-ocsmartcampus/ocsmartcampus_06_0008.html)的URI部分找到resource-path（/v1/iotfm/auth/tokens），拼接起来如下所示。
```
https://xxx.com/v1/iotfm/auth/tokens
```
图1URI示意图   
![](https://support.huaweicloud.com/api-ocsmartcampus/zh-cn_image_0000002496209877.png "点击放大")
![](https://support.huaweicloud.com/api-ocsmartcampus/public_sys-resources/note_3.0-zh-cn.png)
为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。
#### 请求方法
HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。
- **GET**：请求服务器返回指定资源。
- **PUT**：请求服务器更新指定资源。
- **POST**：请求服务器新增资源或执行特殊操作。
- **DELETE**：请求服务器删除指定资源，如删除对象等。
- **HEAD**：请求服务器资源头部。
- **PATCH**：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。
在[生成Token](https://support.huaweicloud.com/api-ocsmartcampus/ocsmartcampus_06_0008.html)的URI部分，您可以看到其请求方法为"POST"，则其请求为：
```
POST https://xxx.com/v1/iotfm/auth/tokens
```
#### 请求消息头
附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头"Content-Type"，请求鉴权信息等。
如下公共消息头需要添加到请求中。
- **Content-Type**：消息体的类型（格式），必选，默认取值为"application/json"，有其他取值时会在具体接口中专门说明。
- **X-Auth-Token** ：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用[生成Token](https://support.huaweicloud.com/api-ocsmartcampus/ocsmartcampus_06_0008.html)接口的响应值，该接口是唯一不需要认证的接口。

- **X-Instance-ID** ：实例ID，必选。对应获取方式参考[基本概念](https://support.huaweicloud.com/api-ocsmartcampus/ocsmartcampus_06_0001.html#ocsmartcampus_06_0001__section1324352394713)的实例获取方式。
- **X-Root-Zone-Id** ：项目ID，非必选。对应获取方式参考[基本概念](https://support.huaweicloud.com/api-ocsmartcampus/ocsmartcampus_06_0001.html#ocsmartcampus_06_0001__section1324352394713)的项目ID获取方式。**该参数是二级资源才有，虽然是非必填字段，建议调用接口时还是带上该参数（不带就会使用默认项目ID）**。
对于[生成Token](https://support.huaweicloud.com/api-ocsmartcampus/ocsmartcampus_06_0008.html)接口，由于不需要认证，所以只添加"Content-Type"和"X-Instance-Id"即可，添加消息头后的请求如下所示。
```
POST https://xxx.com/v1/iotfm/auth/tokens 
Content-Type: application/json
X-Instnace-Id: 616c70686100000000000001
X-Root-Zone-Id: 1957de5bfd2cdce0136d9175
```
#### 请求消息体
请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。
对于[生成Token](https://support.huaweicloud.com/api-ocsmartcampus/ocsmartcampus_06_0008.html)接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中***username*** 为用户名，***\*\*\*\*\*\*\*\****为用户登录密码。
```
POST https://xxx.com/v1/iotfm/auth/tokens 
Content-Type: application/json
X-Instnace-Id: 616c70686100000000000001
 
{ 
    "auth": { 
        "identity": { 
            "methods": [ 
                "password" 
            ], 
            "password": { 
                "user": { 
                    "name": "username", 
                    "password": "********"
                } 
            } 
        }
    } 
}
```
到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于[生成Token](https://support.huaweicloud.com/api-ocsmartcampus/ocsmartcampus_06_0008.html)接口，返回的响应消息头中"x-subject-token"就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。
