Leia o envelope JSON de sucesso e erro e correlacione pedidos por request_id.

Formato das respostas

Envelope JSON

Toda resposta da aplicação usa JSON. Sucesso: data contém o recurso ou a lista e meta.request_id identifica o pedido. Erro: error.type, error.code, error.message e error.details descrevem a falha; meta.request_id ajuda a correlacioná-la com suporte.

Exemplo de erro

HTTP/1.1 401 Unauthorized
Content-Type: application/json
X-Request-Id: req_…

{
  "error": {
    "type": "authentication_error",
    "code": "unauthorized",
    "message": "authentication required",
    "details": null
  },
  "meta": { "request_id": "req_…" }
}