Tratamento de Erros

A API Vorexy segue o padrao RFC 7807 (Problem Details for HTTP APIs) para retornar erros.

Formato de Erro

Exemplo de Erro

{
  "type": "https://vorexy.com/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Os dados fornecidos sao invalidos.",
  "instance": "/api/v1/transactions/create",
  "errors": [
    {
      "field": "amount",
      "message": "O valor deve ser maior que zero."
    }
  ],
  "traceId": "00-abc123-def456-00"
}

Codigos de Status HTTP

400

Bad Request

Requisicao invalida. Verifique os parametros enviados.

401

Unauthorized

Credenciais ausentes ou invalidas.

403

Forbidden

Acesso negado ao recurso.

404

Not Found

Recurso nao encontrado.

429

Too Many Requests

Limite de requisicoes excedido.

500

Internal Server Error

Erro interno do servidor.

Boas Praticas

Sempre verifique o campo status da resposta antes de processar os dados.

Use o campo traceId ao reportar problemas ao suporte.

Implemente retry com backoff exponencial para erros 429 e 5xx.

Valide os dados no cliente antes de enviar para a API.

Exemplo de Tratamento

JavaScript

const response = await fetch('https://vorexy.com/api/v1/transactions/create', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-Client-Id': CLIENT_ID,
    'X-API-Key': API_KEY
  },
  body: JSON.stringify(data)
});
const result = await response.json();
if (!response.ok) {
  console.error('Erro:', result.title);
  console.error('Detalhes:', result.detail);
  console.error('TraceId:', result.traceId);
  
  if (result.errors) {
    result.errors.forEach(err => {
      console.error(`Campo ${err.field}: ${err.message}`);
    });
  }
  return;
}
console.log('Sucesso:', result.data);