构造请求

前提条件

调用API前，需要获取管理员在OneAccess管理门户中已添加应用的通用信息中的ClientId，用以调用API实现相关接口功能。

请求URI

OneAccess请求URI由如下部分组成。

{URI-scheme} :// {domain_name} / {resource-path}

尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。

• URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。
• domain_name：使用OneAccess服务API需要使用用户访问域名，获取方法请参见获取用户访问域名。
• resource-path：资源路径，也即API访问路径。从具体API的URI模块获取，例如“用户名密码登录”API的resource-path为“/api/v2/sdk/login”。

例如您需要获取用户访问域名为“abcdefg.huaweioneaccess.com”的实例的session_token，则需使用用户访问域名“abcdefg.huaweioneaccess.com”，并在用户名密码登录的URI部分找到resource-path（ /api/v2/sdk/login），拼接起来如下所示。

https://abcdefg.huaweioneaccess.com/api/v2/sdk/login

图1 URI示意图

为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起，这是因为URI-scheme都是HTTPS，而domain_name在同一个实例也相同，所以简洁起见将这两部分省略。

请求方法

HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。

• GET：请求服务器返回指定资源。
• PUT：请求服务器更新指定资源。
• POST：请求服务器新增资源或执行特殊操作。
• DELETE：请求服务器删除指定资源，如删除对象等。
• HEAD：请求服务器资源头部。
• PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。

在用户名密码登录的URI部分，您可以看到其请求方法为“POST”，则其请求为：

POST https://abcdefg.huaweioneaccess.com/api/v2/sdk/login

请求消息头

附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如用户Agent信息，应用标识等。

对于用户名密码登录接口，添加消息头后的请求如下所示。

POST https://abcdefg.huaweioneaccess.com/api/v2/sdk/login
X-operating-sys-version: Android 10
X-device-fingerprint: 156aysdna213sac
X-device-ip: 10.10.10.1
X-agent: Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36
X-L: zh
X-client-id: DRrYIqauawN0I8myTMoDTPys6ezGZxnm
X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21

请求消息体（可选）

请求消息体通常以结构化格式（如JSON或XML）发出，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。

每个接口的请求消息体内容不同，并不是每个接口都需要有请求消息体（或者消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。

对于用户名密码登录接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中UserName为用户名，PassWord为密码。

POST https://abcdefg.huaweioneaccess.com/api/v2/sdk/login
X-operating-sys-version: Android 10
X-device-fingerprint: 156aysdna213sac
X-device-ip: 10.10.10.1
X-agent: Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36
X-L: zh
X-client-id: DRrYIqauawN0I8myTMoDTPys6ezGZxnm
X-tenant-id: 08f770f51f80d2f40f38c00cb199fd21

{
  "user_name": "UserName",
  "password": "PassWord"
}

到此，这个请求需要的内容就具备了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于用户名密码登录接口，返回的响应消息体中“session_token”就是登录成功的凭证。有了session_token之后，您就可以用来获取用户信息等。