Pular para o conteúdo principal

​
APIs Comuns FireBanking

As APIs Comuns fornecem funcionalidades essenciais compartilhadas entre todos os métodos de pagamento da FireBanking. Estes endpoints permitem gerenciar sua conta, configurar webhooks para notificações em tempo real e monitorar o status do sistema.

Saldo da Conta

Consulte o saldo atual da sua conta FireBanking

Webhooks

Configure notificações em tempo real

Retry Webhooks

Reenvie webhooks que falharam

​
Características Principais

​
Gestão de Conta

  • Saldo em tempo real: Consulte seu saldo disponível instantaneamente
  • Múltiplas moedas: Suporte completo para BRL (Real Brasileiro)
  • Histórico detalhado: Acesso a movimentações e transações
  • Limites configuráveis: Controle de limites por operação

​
Webhooks Inteligentes

  • Entrega garantida: Sistema de retry automático para webhooks
  • Múltiplos eventos: Notificações para pagamentos, cancelamentos e estornos
  • Assinatura segura: Verificação de integridade com HMAC
  • Teste automático: Validação de endpoints antes da ativação

​
Monitoramento Avançado

  • Health checks: Verificação automática de status da API
  • Métricas em tempo real: Performance e disponibilidade
  • Status por região: Monitoramento distribuído
  • Alertas proativos: Notificações de incidentes

​
Autenticação

Todos os endpoints utilizam autenticação por API Key: 
x-api-key: SUA_CHAVE_DE_API
Inclua sua chave de API no header x-api-key de todas as requisições.
  • Development: Use suas chaves de teste que começam com dev_
  • Production: Use suas chaves de produção que começam com prod_
  • Sandbox: Chaves específicas para ambiente de testes

​
Ambientes Disponíveis

Development

Base URL: https://api-gateway.firebanking.dev Ambiente para desenvolvimento e testes

Produção

Base URL: https://api-gateway.firebanking.com.br Ambiente de produção com dados reais

​
Funcionalidades por Seção

​
Conta

  • Saldo disponível em tempo real
  • Saldo bloqueado (pendente de liquidação)
  • Histórico de movimentações
  • Projeção de recebíveis
  • Limites diários e mensais
  • Configurações de segurança
  • Preferências de notificação
  • Dados da conta

​
Webhooks

  • URLs de callback personalizáveis
  • Eventos selecionáveis
  • Headers customizados
  • Timeouts configuráveis
  • Retry automático inteligente
  • Backoff exponencial
  • Dead letter queue
  • Alertas de falhas
  • Assinatura HMAC-SHA256
  • Verificação de origem
  • Rate limiting
  • Logs de auditoria

​
Sistema

  • Status geral da API
  • Latência por endpoint
  • Disponibilidade por região
  • Dependências externas
  • Tempo de resposta
  • Taxa de erro
  • Throughput
  • Capacity planning

​
Padrões de Resposta

​
Respostas de Sucesso

Exemplo de Resposta
{
  "success": true,
  "data": {
    "balance": 15420.50,
    "currency": "BRL",
    "last_updated": "2024-01-15T10:30:00Z"
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:05Z",
    "request_id": "req_abc123"
  }
}

​
Tratamento de Erros

Exemplo de Erro
{
  "error": {
    "code": "INSUFFICIENT_BALANCE",
    "message": "Saldo insuficiente para esta operação",
    "details": {
      "available": 100.00,
      "required": 150.00
    }
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:05Z",
    "request_id": "req_xyz789"
  }
}

​
Início Rápido

​
1. Obtenha suas Credenciais

Configure sua conta e obtenha suas chaves de API no Dashboard FireBanking:
  • API Key: Para autenticação de requisições
  • Webhook Secret: Para validação de webhooks
  • Ambiente: Development ou Production

​
2. Teste a Conectividade

Verificar Status da API
curl -X GET "https://api-gateway.firebanking.dev/v1/account/balance" \
  -H "x-api-key: SUA_CHAVE_DE_API"

​
3. Consulte seu Saldo

Consultar Saldo
curl -X GET "https://api-gateway.firebanking.dev/account/balance" \
  -H "x-api-key: SUA_CHAVE_DE_API"

​
Limites e Quotas

Rate Limiting: As APIs Comuns implementam rate limiting para garantir estabilidade e fair usage.
EndpointLimiteJanela
/account/balance60 req/minPor API Key
/webhooks/*120 req/minPor API Key

​
Próximos Passos

Consultar Saldo

Implemente consulta de saldo em sua aplicação

Configurar Webhooks

Configure notificações automáticas

Retry Webhooks

Reenvie webhooks que falharam

Downloads

Baixe coleções para Insomnia e Postman
Dica: Comece sempre verificando a conectividade com /v1/account/balance antes de implementar outros endpoints.