Resposta

Códigos de status

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

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

Por exemplo, se o código de status 201 for retornado para chamar a API usada para obter um token de usuário, a solicitação será 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, em que x-subject-token é o token de usuário desejado. Você pode usar esse 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

Um corpo de resposta geralmente é retornado em um formato estruturado, correspondendo ao Content-Type no cabeçalho da resposta, e é usado para transferir conteúdo diferente do cabeçalho da resposta.

Veja a seguir parte do corpo da resposta da API para obter um token de usuário. Por uma questão de espaço, apenas parte do conteúdo é exibido aqui.

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

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": {
        "message": "The request you have made requires authentication.",
        "title": "Unauthorized"
    }
}

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