构造请求
本节介绍API请求的组成，并以调用OneAccess管理类接口必须的“获取访问凭据”为例接口说明如何调用API，获取访问凭证后，可用于调用其他管理类API。
前提条件
调用API前，管理员在OneAccess管理门户中需参考授权API授权API，并且获取管理员在OneAccess管理门户中已添加应用的通用信息中的ClientId以及ClientSecret，用以调用API实现相关接口功能。
请求URI
OneAccess请求URI由如下部分组成。
{URI-scheme} :// {domain_name} / {resource-path} ? {query-string}
尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。
|
参数 |
描述 |
|---|---|
|
URI-scheme |
表示用于传输请求的协议，当前所有API均采用HTTPS协议。 |
|
domain_name |
使用OneAccess服务API需要使用用户访问域名，获取方法请参见获取用户访问域名。 |
|
resource-path |
资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取访问凭证”API的resource-path为“/api/v2/tenant/token”。 |
|
query-string |
查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 |
例如您需要获取用户访问域名为“abcdefg.huaweioneaccess.com”的实例Access Token，则需使用用户访问域名“abcdefg.huaweioneaccess.com”，并在获取访问凭据的URI部分找到resource-path（/api/v2/tenant/token），拼接起来如下所示。
https://abcdefg.huaweioneaccess.com/api/v2/tenant/token
为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而domain_name在同一个实例也相同，所以简洁起见将这两部分省略。
请求方法
|
方法 |
说明 |
|---|---|
|
GET |
请求服务器返回指定资源。 |
|
PUT |
请求服务器更新指定资源。 |
|
POST |
请求服务器新增资源或执行特殊操作。 |
|
DELETE |
请求服务器删除指定资源，如删除对象等。 |
|
HEAD |
请求服务器资源头部。 |
|
PATCH |
请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 |
在获取访问凭据的URI部分，您可以看到其请求方法为“POST”，则其请求为：
POST https://abcdefg.huaweioneaccess.com/api/v2/tenant/token
请求消息头
附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。
|
名称 |
描述 |
是否必选 |
示例 |
|---|---|---|---|
|
Content-Type |
消息体的类型（格式）。默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 |
是 |
application/json |
|
Accept |
接受响应类型。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 |
否 |
application/json |
|
Content-Length |
请求body长度，单位为Byte。 |
否 |
3495 |
|
Authorization |
认证凭据。如获取用户信息接口，值为Bearer {access_token}。 |
否 |
Bearer {access_token} |
对于获取访问凭据接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。
POST https://{domain_name}/api/v2/tenant/token
Content-Type: application/x-www-form-urlencoded
请求消息体（可选）
该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。
对于获取访问凭据接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中UserName为注册应用后分配的接口认证凭证ID，Password为注册应用后分配的接口认证凭证密钥。
POST https://{domain_name}/api/v2/tenant/token?grant_type=client_credentials
Content-Type: application/x-www-form-urlencoded
Authorization: Basic eFFp******************************************************************************************************bzZaNg==
到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取访问凭据接口，返回的响应消息体中“access_token”就是需要获取的Access Token。有了Token之后，您就可以使用Token认证调用其他API。
PostMan调用示例：
