Respuesta

Código de estado

Después de enviar una solicitud, recibirá una respuesta, que incluye un código de estado, el encabezado de la respuesta y el cuerpo de la respuesta.

Un código de estado es un grupo de dígitos, que van desde 1xx hasta 5xx. Indica el estado de una solicitud. Para obtener más información, consulte Códigos de estado.

Por ejemplo, si se devuelve el código de estado 201 para llamar a la API usada para obtener un token de usuario, la solicitud tiene éxito.

Encabezado de respuesta

Similar a una solicitud, una respuesta también tiene un encabezado, por ejemplo, Content-Type.

Figura 1 muestra los campos de encabezado de respuesta para la API utilizada para obtener un token de usuario. El campo de encabezado x-subject-token es el token de usuario deseado. Este token se puede utilizar para autenticar la llamada de otras API.

Figura 1 Campos de cabecera de la respuesta a la solicitud de obtención de un token de usuario

Cuerpo de respuesta

El cuerpo de una respuesta se devuelve a menudo en formato estructurado como se especifica en el campo de encabezado Content-Type. El cuerpo de la respuesta transfiere contenido excepto el encabezado de la respuesta.

Lo siguiente es parte del cuerpo de respuesta para la API utilizada para obtener un token de usuario.

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

Si se produce un error durante la llamada a la API, se mostrará un código de error y un mensaje. A continuación se muestra un cuerpo de respuesta de error.

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

En el cuerpo de la respuesta, error_code es un código de error y error_msg proporciona información sobre el error.