Criação de uma solicitação de API

URI de solicitação

Um URI de solicitação está no seguinte formato:

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

Embora um URI de solicitação esteja incluída em um cabeçalho de solicitação, a maioria das linguagens de programação ou estruturas exigem que o URI de solicitação seja transmitida separadamente, em vez de ser transmitida em uma mensagem de solicitação.

Para simplificar a exibição de URI, cada API é fornecida apenas com um resource-path e um método de solicitação. Isso ocorre porque o valor de URI-scheme de todas as API é HTTPS e os pontos de extremidade em uma região são os mesmos. Portanto, as duas partes são omitidas.

Métodos de solicitação

Por exemplo, no URI para obtenção de um token de usuário, o método de requisição é POST, e a requisição é a seguinte:

Cabeçalho da solicitação

Você também pode adicionar campos adicionais a uma solicitação, como os campos exigidos por um URI especificado ou um método HTTP. Por exemplo, adicione Content-Type que define um tipo de corpo de solicitação para solicitar as informações de autenticação.

Além de suportar a autenticação baseada em token, as APIs suportam a autenticação usando a chave de acesso ID/chave de acesso secreta (AK/SK). Durante a autenticação baseada em AK/SK, um SDK é usado para assinar a solicitação, os campos de cabeçalho Authorization (informações de assinatura) e X-Sdk-Date (hora em que a solicitação é enviada) são adicionados automaticamente à solicitação.

Para obter mais informações, consulte AK/SK-based Authentication em Autenticação.

A API para obter um token de usuário não requer autenticação. Portanto, essa API requer apenas a adição do campo Content-Type. A solicitação com o cabeçalho Content-Type adicionado é a seguinte:

(Opcional)Corpo de solicitação

Esta parte é opcional. Um corpo de solicitação é geralmente enviado em um formato estruturado (por exemplo, JSON ou XML), correspondente ao Content-Type no cabeçalho da solicitação, e é usado para transferir conteúdo diferente do cabeçalho da solicitação. Se o corpo da solicitação contiver caracteres de largura total, esses caracteres devem ser codificados em UTF-8.

O corpo da solicitação varia conforme as API. As certas API não exigem o corpo da solicitação, como as API GET e DELETE.

No caso da API usada para obter um token de usuário, os parâmetros da solicitação e a descrição do parâmetro podem ser obtidos da solicitação da API. O seguinte fornece um exemplo de solicitação com um corpo incluído. Substitua username, domianname, ******** (login senha) e xxxxxxxxxxxxxxxxxx (ID do projeto, por exemplo, ap-southeast-1) pelos valores reais. Para regiões e endpoints, consulte Regiões e pontos de extremidade.

scope especifica onde um token entra em vigor. No exemplo a seguir, o token terá efeito somente nos recursos especificados pelo código do projeto. Você pode definir o escopo para uma conta ou um projeto em uma conta. Para obter detalhes, consulte obtenção de um token de usuário.

POST https://iam.ap-southeast-1.myhuaweicloud.com/v3/auth/tokens
Content-Type: application/json

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

Se todos os dados exigidos por uma solicitação estiverem disponíveis, você poderá enviar a solicitação para chamar uma API por meio de curl, Postman ou coding. Para a API usada para obter um token de usuário, x-subject-token no cabeçalho de resposta é o token de usuário desejado. Em seguida, você pode usar o token para autenticar a chamada de outras API.