Respuesta
Código 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.
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
Similar a una solicitud, una respuesta también tiene una cabecera, 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.
(Opcional) 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 ususario.
1 2 3 4 5 6 7 8 9 10 11 12 |
{ "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "az-01", ...... |
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.
1 2 3 4 |
{ "error_msg": "The format of message is error", "error_code": "AS.0001" } |
En el cuerpo de la respuesta, error_code es un código de error y error_msg proporciona información sobre el error.