Resposta

Código 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 obter um token de usuário, a solicitação será bem sucedida.

Cabeçalho de resposta

Semelhante a uma solicitação, uma resposta também tem um cabeçalho, por exemplo, Content-Type.

Figura 1 mostra os campos de cabeçalho de resposta da API usada para obter um token de usuário. O campo de cabeçalho x-subject-token é o token de usuário desejado. Esse token pode ser usado para autenticar a chamada de outras API.

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

Corpo da resposta

O corpo de uma resposta geralmente é retornado em formato estruturado, conforme especificado no campo de cabeçalho Content-Type. O corpo da resposta transfere o conteúdo, exceto o cabeçalho da resposta.

O seguinte é parte do corpo de resposta da API usada para obter um token de usuário.

{ 
    "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, um código de erro e uma mensagem serão exibidos. O seguinte mostra um corpo de resposta de erro.

{
  "error_code": "FGS.0111",
  "error_msg": "xxxxxxxxx"
} 

No corpo da resposta, error_code é um código de erro e error_msg fornece informações sobre o erro.