Valores retornados

Código de status

Depois de enviar uma solicitação, você receberá uma resposta, incluindo o código de status, o cabeçalho da resposta e o corpo da resposta.

Um código de status é um grupo de dígitos que variam de 1xx a 5xx. Indica o status de uma resposta. Para obter mais informações, consulte Código de status.

Se o código de status 201 for retornado para a chamada da API para obtenção de um token de usuário, a solicitação é bem-sucedida.

Cabeçalho de resposta

Um cabeçalho de resposta corresponde a um cabeçalho de solicitação, por exemplo, Content-type.

Figura 1 mostra o cabeçalho de resposta para a API de obtenção de um token de usuário, no qual x-subject-token é o token de usuário desejado. Em seguida, você pode usar o token para autenticar a chamada de outras API.

Figura 1 Cabeçalho da resposta à solicitação para obter um token de usuário

(Opcional) Corpo de resposta

O corpo de uma resposta geralmente é retornado em formato estruturado (como JSON ou XML), conforme especificado no campo de cabeçalho Content-type. O corpo da resposta transfere o conteúdo, exceto o cabeçalho da resposta.

Você pode obter um token chamando uma API. Veja a seguir parte do corpo da resposta da API para obter um token de usuário.

{
    "token": {
        "expires_at": "2019-02-13T06:52:13.855000Z",
        "methods": [
            "password"
        ],
        "catalog": [
            {
                "endpoints": [
                    {
                        "region_id": "XXXXXX",
......

Se ocorrer um erro durante a chamada da API, o sistema retornará um código de erro e uma mensagem para você. A seguir, mostra o formato de um corpo de resposta de erro:

{
    "error_msg": "The format of message is error",
    "error_code": "AS.0001"
}

Nas informações anteriores, error_code é um código de erro, e error_msg descreve o erro.