# 构造请求
本节介绍REST API请求的组成，并以使用Token Exchange模式获取access_token为例说明如何调用API，该API获取access_token，access_token可以用于调用其他API时鉴权。
#### 请求URI
请求URI由如下部分组成。
**{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}**
尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。
表1URI中的参数说明 
| 参数                                          | 描述                                                                                                 |
|:---|:---|
| URI-scheme    | 表示用于传输请求的协议，当前华为云DocZip智能文档服务所有API均采用**HTTPS**协议。                   |
| Endpoint     | 指定承载REST服务端点的DocZip服务器域名或IP，由DocZip分配。                                                          |
| resource-path  | 资源路径，即API访问路径。从具体API的URI模块获取，例如"申请令牌"API的resource-path为"/v1/app/auth/token"。                        |
| query-string | 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个"？"，形式为"参数名=参数取值"，例如"limit=10"，表示查询不超过10条数据。多个查询参数之间使用"\&"隔开。 |
   
例如，使用Token Exchange模式获取access_token，"/v1/app/auth/token"为资源路径，当前DocZip服务域名为"doczip-api.cn-north-4.myhuaweicloud.com"，URI拼接起来如下所示：
```
https://doczip-api.cn-north-4.myhuaweicloud.com/v1/app/auth/token
```
#### 请求方法
HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。
**表2 HTTP方法**
| **方法**  |                 **说明**                 |
|---|---|
| GET     | 请求服务器返回指定资源，如获取对象列表。                    |
| PUT     | 请求服务器更新指定资源，如按记录ID更新数据。                 |
| POST  | 请求服务器新增资源或执行特殊操作，如新增对象数据。               |
| DELETE | 请求服务器删除指定资源，如按记录ID列表删除对象数据。           |
| HEAD     | 请求服务器资源头部。                             |
| PATCH   | 请求服务器更新资源的部分内容。当资源不存在时，PATCH可能会去创建一个新的资源。 |
   
在使用Token Exchange模式获取access_token的URI部分，您可以看到其请求方法为"POST"，则其请求为：
```
POST https://doczip-api.cn-north-4.myhuaweicloud.com/v1/app/auth/token
```
#### 请求消息头
附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头"Content-Type"，请求鉴权信息等。
详细的公共请求消息头字段请参见表3。
**表3 公共请求消息头**
|       消息头名称        |                                                                                                                                                                              描述                                                                                                                                                                               |                                   是否必选                                   |
|---|---|---|
| Content-Type         | HTTP协议中设定的一个参数，用于标识返回的内容用什么格式去解析。默认配置为"application/json"，表示浏览器将返回内容解析为json对象。 部分接口类型为"application/x-www-form-urlencoded"。                                                                                                                                                                                      | 是                                                                         |
| X-Cloud-Doc-AppId | 应用ID                                                                                                                                                                                                                                                                                                                                                         | 是                                                                      |
| Authorization    | 认证凭证，格式为Bearer {access_token}。 access_token是调用接口API要用到的访问令牌，在调用API的时候将access_token加到请求消息头，从而通过身份认证，获得操作API的权限。 当第三方系统要访问业务接口时，需要提前使用Token Exchange协议进行接入认证，在租户管理台获取应用ID（App ID）和应用密钥（App Secret），并进行身份提供商配置，调用接口"/v1/app/auth/token"获取access_token，从而获取业务接口的访问令牌。 | 否。 使用access_token认证时该字段必选。 |
   
#### 请求消息体
请求消息体通常以结构化格式（如JSON）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。
对于使用Token Exchange模式，获取的用户access_token接口，您可以从[表2 请求参数说明]看到所需的请求参数及参数说明。
 表2**请求参数说明** 
| 参数名称                 | 类型      | 必选（M）/可选（O） | 参数位置  | 参数含义                                                                                                                                                                                                                              |
|:---|:---|:---|:---|:---|
| grant_type            | String | M           | Body   | 授权类型，固定值：urn:ietf:params:oauth:grant-type:token-exchange                                                                                                                                                                           |
| subject_token      | String  | M        | Body | IdP签发的凭证。当grant_type为token-exchange时必填。支持OIDC id_token（JWT）、自签JWT断言                                                                                                                                                                |
| subject_token_type | String | M          | Body  | subject_token的凭证类型标识，取值详见 urn:ietf:params:oauth:token-type:id_token urn:ietf:params:oauth:token-type:jwt                              |
| client_id           | String | M          | Body  | 客户端ID，获取方法如下： 1. 在[DocZip控制台](https://console.huaweicloud.com/doczip/#/console/overview)中，单击"应用管理"，进入应用管理页面。 2. 点击"基础信息"获取APP ID的值 |
| client_secret        | String | M           | Body | 客户端密钥。 参考client_id，获取APP Secret的值。                                                                                                                                                  |
   
将消息体加入后的请求如下所示，字段需要根据实际值填写。
**示例**：
```
POST https://doczip-api.cn-north-4.myhuaweicloud.com/v1/app/auth/token
Content-Type: application/json
{
  "grant_type": "urn:ietf:params:oauth:grant-type:token-exchange",
  "subject_token": "xxx",
  "subject_token_type": "urn:ietf:params:oauth:token-type:id_token",
  "client_id": "********",
  "client_secret": "********"
}
```
**发起请求**
到这里为止这个请求需要的内容就具备齐全了，您可以使用[curl](https://curl.haxx.se/)、[Postman](https://www.getpostman.com/)或直接编写代码等方式发送请求调用API。
对于使用Token Exchange模式获取access_token接口，返回的响应消息中，"access_token"就是需要获取的access_token。有了access_token之后，就可以使用access_token调用DocZip的其他API。