Tratamento de Erros

A API ApexPy retorna erros em um formato padronizado para facilitar o tratamento.

Estrutura de Erro

Todos os erros seguem este formato:

{
  "success": false,
  "error": {
    "type": "validation_error",
    "code": "invalid_request",
    "message": "Descrição do erro",
    "param": "campo_específico" // Opcional
  }
}

Tipos de Erro

Tipo	Descrição	Status HTTP
`validation_error`	Erro de validação de dados	400 ou 422
`authentication_error`	Falha na autenticação	401
`authorization_error`	Sem permissão para a ação	403
`not_found`	Recurso não encontrado	404
`rate_limit_error`	Limite de requisições excedido	429
`internal_error`	Erro interno do servidor	500

Exemplos de Erros

Erro de Validação

{
  "success": false,
  "error": {
    "type": "validation_error",
    "code": "amount_below_minimum",
    "message": "The transaction amount is below the minimum ticket allowed",
    "param": "amount"
  }
}

Erro de Autenticação

{
  "success": false,
  "error": {
    "type": "authentication_error",
    "code": "authentication_required",
    "message": "Authorization header with Bearer token is required"
  }
}

Recurso Não Encontrado

{
  "success": false,
  "error": {
    "type": "not_found",
    "code": "resource_not_found",
    "message": "Charge not found"
  }
}