Valores devueltos

Código de Estado

Después de enviar una solicitud, recibirá una respuesta, que incluye el 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 respuesta. Para obtener más información, consulte Código de estado.

Si se devuelve el código de estado 201 para la llamada de la API para obtener un token de usuario, la solicitud se ha realizado 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-toke x-subject-token es el token de usuario deseado. A continuación, puede usar el 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 la cabecera de respuesta, y se usa para transferir contenido distinto de la cabecera de respuesta.

A continuación se muestra parte del cuerpo de respuesta para que la API obtener un token de usuario.

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

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_msg": "The format of message is error",
    "error_code": "AS.0001"
}

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