# 构造请求 本节介绍API请求的组成，并以调用OneAccess基于OAuth2.0的应用认证集成所需接口"获取Access Token"为例说明如何调用API，获取Access Token，Access Token可用于调用获取用户信息API。 您还可以通过这个视频教程了解如何构造请求调用API： 。 #### 前提条件 调用API前，需要获取管理员在OneAccess管理门户中已添加应用的[通用信息](https://support.huaweicloud.com/usermanual-oneaccess/oneaccess_03_0074.html)中的ClientId以及ClientSecret，可以调用API实现相关接口功能。 #### 请求URI OneAccess请求URI由如下部分组成。 **{URI-scheme} :// {domain_name} / {resource-path} ? {query-string}** 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 - **URI-scheme** ：表示用于传输请求的协议，当前所有API均采用**HTTPS**协议。 - **domain_name** ：使用OneAccess服务API需要使用用户访问域名，获取方法请参见[获取用户访问域名](https://support.huaweicloud.com/api-oneaccess/oneaccess_04_0001.html#oneaccess_04_0001__section20892162113512)。 - **resource-path**：资源路径，也即API访问路径。从具体API的URI模块获取，例如"获取用户Token"API的resource-path为"api/v1/oauth2/token"。 - **query-string**：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个"？"，形式为"参数名=参数取值"，例如"limit=10"，表示查询不超过10条数据。 例如您需要获取用户访问域名为"abcdefg.huaweioneaccess.com"的实例Access Token，则需使用用户访问域名"abcdefg.huaweioneaccess.com"，并在获取Access Token的URI部分找到resource-path（ /api/v1/oauth2/token），拼接起来如下所示。 ``` https://abcdefg.huaweioneaccess.com/api/v1/oauth2/token ``` 图1URI示意图 ![](https://support.huaweicloud.com/api-oneaccess/zh-cn_image_0000001507226342.png) ![](https://support.huaweicloud.com/api-oneaccess/public_sys-resources/note_3.0-zh-cn.png) 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而domain_name在同一个实例也相同，所以简洁起见将这两部分省略。 #### 请求方法 HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。 - **GET**：请求服务器返回指定资源。 - **PUT**：请求服务器更新指定资源。 - **POST**：请求服务器新增资源或执行特殊操作。 - **DELETE**：请求服务器删除指定资源，如删除对象等。 - **HEAD**：请求服务器资源头部。 - **PATCH**：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取Access的URI部分，您可以看到其请求方法为"POST"，则其请求为： ``` POST https://abcdefg.huaweioneaccess.com/api/v1/oauth2/token ``` #### 请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头"Content-Type"，请求鉴权信息等。 详细的公共请求消息头字段请参见[表1]。 表1公共请求消息头 | 名称 | 描述 | 是否必选 | 示例 | |:---|:---|:---|:---| | Content-Type | 消息体的类型（格式）。默认取值为"application/json"，有其他取值时会在具体接口中专门说明。 | 是 | application/json | | Accept | 接受响应类型。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 | 否 | application/json | | Content-Length | 请求body长度，单位为Byte。 | 否 | 3495 | 对于获取Access Token接口，由于不需要认证，所以只添加"Content-Type"即可，添加消息头后的请求如下所示。 ``` POST https://abcdefg.huaweioneaccess.com/api/v1/oauth2/token Content-Type: application/json ``` #### 请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取Access Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中***domain_name*** 为用户访问域名，***\*\*\*\*\*\*\**** 为认证登录后回调获取的授权码，***ClientId*** 为注册应用后分配的接口认证凭证ID，***ClientSecret*** 为注册应用后分配的接口认证凭证密钥，***https://example.com***为注册应用时填写的回调地址。 ``` POST https://abcdefg.huaweioneaccess.com/api/v1/oauth2/token Content-Type: application/json code=******& client_id=ClientId& client_secret=ClientSecret& redirect_uri=https://example.com& grant_type=authorization_code ``` 到这里为止这个请求需要的内容就具备齐全了，您可以使用[curl](https://curl.haxx.se/)、[Postman](https://www.getpostman.com/)或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息体中"access_token"就是需要获取的Access Token。有了Token之后，您就可以使用Token认证调用其他API。