Respuesta

Códigos de estado

Después de enviar una solicitud, recibirá una respuesta, que incluye un código de estado, un encabezado de respuesta y un cuerpo de 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 utilizada para obtener un token de usuario, la solicitud se realiza correctamente.

Encabezado de respuesta

Un encabezado de respuesta corresponde a un encabezado de solicitud, por ejemplo, Content-Type.

Figura 1 muestra la cabecera de respuesta para la API de obtener un token de usuario, en el que x-subject-token es el token de usuario deseado. Puede usar este token para autenticar la llamada de otras API.

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

(Opcional) Cuerpo de respuesta

Un cuerpo de respuesta se devuelve generalmente en un formato estructurado, correspondiente al Content-Type en el encabezado de respuesta, y se usa para transferir contenido distinto del encabezado de respuesta.

A continuación se muestra parte del cuerpo de respuesta para que la API obtenga un token de usuario. En aras del espacio, solo una parte del contenido se muestra aquí.

{
    "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, el sistema le devuelve un código de error y un mensaje. A continuación se muestra el formato de un cuerpo de respuesta de error:

{
    "error": {
        "message": "The request you have made requires authentication.",
        "title": "Unauthorized"
    }
}

En la información anterior, error_code es un código de error, y error_msg describe el error.