Making an API Request

Request URI

A request URI is in the following format:

{URI-scheme}://{Endpoint}/{resource-path}?{query-string}

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

Request Methods

For example, in the URI for obtaining a user token, the request method is POST, and the request is as follows:

POST https://{{endpoint}}/v3/auth/tokens

Request Header

You can also add additional fields to a request, such as the fields required by a specified URI or an HTTP method. For example, add Content-Type that defines a request body type to request for the authentication information.

The API used to obtain a user token does not require authentication. Therefore, this API only requires adding the Content-Type field. The request with the added Content-Type header is as follows:

POST https://{{endpoint}}/v3/auth/tokens
Content-Type: application/json

(Optional) Request Body

This part is optional. A request body is generally sent in a structured format (for example, JSON or XML), corresponding to Content-Type in the request header, and is used to transfer content other than the request header. If the request body contains Chinese characters, convert the Chinese characters into the UTF-8 encoding format.

The request body varies according to the APIs. Certain APIs do not require the request body, such as the GET and DELETE APIs.

For the API used to obtain a user token, the request parameters and parameter description can be obtained in the API request. The following provides an example request with a body included. Replace username, domianname, ******** (login password), and xxxxxxxxxxxxxxxxxx (project name) with actual values. You can obtain the values from Regions and Endpoints.

scope specifies where a token takes effect. In the following example, the token takes effect only on the resources specified by the project ID. You can set the scope to an account or a project under an account. For details, see Obtaining a User Token.

POST https://{{endpoint}}/v3/auth/tokens
Content-Type: application/json

{
    "auth": {
        "identity": {
            "methods": [
                "password"
            ],
            "password": {
                "user": {
                    "name": "username",
                    "password": "********",
                    "domain": {
                        "name": "domianname"
                    }
                }
            }
        },
        "scope": {
            "project": {
                "name": "xxxxxxxxxxxxxxxxxx"
            }
        }
    }
}

If all data required by a request is available, you can send the request to call an API through curl, Postman, or coding. For the API used to obtain a user token, x-subject-token in the response header is the desired user token. Then, you can use the token to authenticate the calling of other APIs.