Recomendação: Para uma melhor experiência de desenvolvimento, recomendamos o uso do Insomnia REST Client que oferece melhor suporte aos recursos da nossa API e ambientes pré-configurados.
Coleções Disponíveis
Insomnia
Baixe a coleção completa para o Insomnia REST Client (formato YAML v5):Coleção Insomnia
firebanking-insomnia-v5.yamlInclui todos os 27 endpoints da API organizados por categoria com ambientes de Development e Production pré-configurados.
Postman
Baixe a coleção completa para o Postman (formato JSON v2.1.0):Coleção Postman
firebanking-postman-collection.jsonInclui todos os 27 endpoints da API organizados em pastas por método de pagamento com variáveis de ambiente configuráveis.
Como Usar
Importando no Insomnia
- Abra o Insomnia REST Client
- Clique em Create → Import from File
- Selecione o arquivo
firebanking-insomnia-v5.yamlbaixado - Escolha entre os ambientes Development ou Production
- Configure sua chave da API nas variáveis de ambiente
Importando no Postman
- Abra o Postman
- Clique em Import no canto superior esquerdo
- Selecione o arquivo
firebanking-postman-collection.jsonbaixado - Crie um novo ambiente ou configure as variáveis:
base_url: URL base da API (https://api-gateway.firebanking.devpara desenvolvimento)api_key: Sua chave da API
Variáveis de Ambiente
Para usar as coleções, configure as seguintes variáveis:| Variável | Development | Production |
|---|---|---|
base_url | https://api-gateway.firebanking.dev | https://api-gateway.firebanking.com.br |
api_key | Sua chave de desenvolvimento | Sua chave de produção |
Lembre-se de substituir as chaves de API pelas suas chaves reais:
a9b484fc-90a6-4255-9394-e3c1ca0633b9→ sua chave de desenvolvimentoYOUR_PRODUCTION_API_KEY→ sua chave de produção
Estrutura das Coleções
As coleções incluem todos os endpoints organizados nas seguintes categorias:- Cartão de Crédito: Pagamentos, tokenização e assinaturas
- PIX: Cobrança (Cash In) e saque (Cash Out)
- Boleto Bancário: Emissão e gestão
- Conta: Consulta de saldo
- Sistema: Verificação de conectividade
- Webhooks: Configuração e testes
Suporte
Precisa de ajuda?- Documentação: Navegue pelas seções da API para exemplos detalhados