Making an API Request

Prerequisites

Before calling APIs, obtain the ClientId of added applications in the administrator portal from Basic Information.

Request URI

A request URI is in the following format:

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

Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.

• URI-scheme: Protocol used to transmit requests. All APIs use HTTPS.
• domain_name: User access domain name that you must specify when you call a OneAccess API. For details about how to obtain the domain name, see Obtaining the User Access Domain Name.
• resource-path: Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to log in with a username and password is /api/v2/sdk/login.

For example, to obtain a session_token for the domain name abcdefg.huaweioneaccess.com, provide this domain name and obtain the resource-path (/api/v2/sdk/login) in the URI of the API used to obtain a session_token. Then, construct the URI as follows:

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

Figure 1 Example URI

To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the domain_name values of all APIs in the same instance are identical.

Request Methods

The HTTP protocol defines the following request methods that can be used to send a request to the server.

• GET: requests the server to return specified resources.
• PUT: requests the server to update specified resources.
• POST: requests the server to add resources or perform special operations.
• DELETE: requests the server to delete specified resources, for example, an object.
• HEAD: requests the server to return the response header only.
• PATCH: requests the server to update partial content of a specified resource. If the resource does not exist, a new resource will be created.

For example, in the case of the API used to log in with a username and password, the request method is POST. The request is as follows:

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

Request Header

You can also add additional fields to a request, such as the fields required by a specified URI or HTTP method. For example, fields that indicate user agent information and application ID.

An example request for calling the API used to log in with a username and password is as follows:

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

(Optional) Request Body

The body of a request is often sent in a structured format (for example, JSON or XML) to transfer content except the request header.

The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.

In the case of the API used to log in with a username and password, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace UserName and Password with the actual username and password, respectively.

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"
}

If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding. In the response to the API used to log in with a username and password, session_token is the credential indicating successful login. This session_token can then be used to obtain user information.