Resposta

Código de status

Após enviar uma solicitação, você receberá uma resposta, incluindo o código de status, o cabeçalho da resposta e o corpo da resposta.

Um código de status é um grupo de dígitos que variam de 1xx a 5xx. Ele indica o status de uma resposta. Para obter mais informações, consulte Códigos de status.

Por exemplo, se o código de status 201 for retornado para a chamada da API usada para obter um token de usuário, a solicitação é 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 o cabeçalho de resposta da API usada para obter um token de usuário. O campo de cabeçalho x-subject-token é o desejado token de usuário. Esse token pode ser usado para autenticar a chamada de outras APIs.

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

(Opcional) Corpo de resposta

Esta parte é opcional. O corpo de uma resposta é geralmente retornado em formato estruturado (por exemplo, JSON ou XML), conforme especificado no campo cabeçalho Content-Type. O corpo da resposta transfere o conteúdo, exceto o cabeçalho da resposta.

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

{
	"error_code": "AS.0001",
	"error_msg": "The format of message is error"
}

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