Skip to content

quickstart.mdx

Latest commit

 

History

History
223 lines (166 loc) · 5.95 KB

quickstart.mdx

File metadata and controls

223 lines (166 loc) · 5.95 KB
title Início Rápido
description Escolha seu método de pagamento e comece a integrar em menos de 10 minutos

Bem-vindo à API FireBanking

A FireBanking oferece múltiplos métodos de pagamento para atender diferentes necessidades de negócio. Escolha o método ideal para seu caso e siga nosso guia específico de integração.

**⚡ Instantâneo** • **💰 Taxa baixa** • **🕐 24/7** 
Ideal para pagamentos rápidos e custo baixo
**⚡ Instantâneo** • **📅 Parcelamento** • **🔄 Recorrente** 
Ideal para e-commerce e parcelamento
**🏦 Universal** • **💰 Taxa fixa** • **📄 Comprovante** 
Ideal para valores altos e B2B
**Não sabe qual escolher?** Acesse nossa [comparação detalhada](/guides/integration/overview) dos métodos de pagamento.

Configuração Inicial

1. Obtenha suas Credenciais

  1. Acesse o Dashboard FireBanking
  2. Vá em API & Webhooks → Chaves de API
  3. Copie sua chave de Sandbox (formato: a9b484fc-90a6-4255-9394-e3c1ca0633b9)
a9b484fc-90a6-4255-9394-e3c1ca0633b9

2. Ambientes Disponíveis

**Base URL**: `https://api-gateway.firebanking.dev` 
Use para desenvolvimento e testes
**Base URL**: `https://api-gateway.firebanking.com.br` 
Use apenas com dados reais validados

3. Estrutura da API

Nossa API é modular e organizada por método de pagamento:

- **PIX**: `{base_url}/pix/v2/payment` - **Cartão**: `{base_url}/credit-card/v1/payment` - **Boleto**: `{base_url}/bank-slip/v1/payment` - **Autenticação**: Header `x-api-key` obrigatório - **Formato JSON**: Todas as requisições e respostas - **Códigos HTTP**: Semânticos (200, 400, 403, 500, etc.) - **IDs únicos**: Identificadores consistentes - **Webhooks**: Notificações em tempo real

Teste sua Conexão

Verifique se sua autenticação está funcionando:

```bash cURL curl -X GET "https://api-gateway.firebanking.dev/v1/account/balance" \ -H "x-api-key: "SUA_CHAVE_DE_API" \ -H "Content-Type: application/json" ``` 
const response = await fetch(
  "https://api-gateway.firebanking.dev/v1/account/balance",
  {
    headers: {
      "x-api-key": "SUA_CHAVE_DE_API",
      "Content-Type": "application/json",
    },
  }
);

const balance = await response.json();
console.log("Conta ativa:", balance.account_status === "active");
import requests

response = requests.get(
    'https://api-gateway.firebanking.dev/v1/account/balance',
    headers={
        'x-api-key': 'SUA_CHAVE_DE_API',
        'Content-Type': 'application/json'
    }
)

balance = response.json()
print('Conta ativa:', balance['account_status'] == 'active')

Resposta esperada:

{
  "id": "UM_ID_UNICO",
  "totalBalance": 0,
  "blockedBalance": 0,
  "availableBalance": 0
}

Guias de Integração por Método

Agora que você tem suas credenciais configuradas, escolha seu método preferido e siga o guia específico:

🚀 Recomendado para Iniciantes: PIX

**Por que começar com PIX?** - ✅ Integração mais simples - ✅ Menor custo (taxa fixa) - ✅ Confirmação instantânea - ✅ Funciona 24h/7 dias

Tempo estimado: 15-20 minutos

💳 Para E-commerce: Cartão de Crédito

**Ideal se você precisa de:** - ✅ Parcelamento em até 12x - ✅ Assinaturas recorrentes - ✅ Tokenização de cartões - ✅ Pré-autorização

Tempo estimado: 25-30 minutos

🏦 Para Valores Altos: Boleto Bancário

**Ideal se você tem:** - ✅ Clientes sem cartão - ✅ Valores acima de R$ 200 - ✅ Necessidade de comprovante físico - ✅ Flexibilidade de prazo

Tempo estimado: 20-25 minutos

Recursos Adicionais

Entenda qual método escolher para cada cenário Aprenda sobre fluxos e conceitos fundamentais Receba notificações em tempo real Guia completo para testes e validação

Implementação Múltipla

Muitas empresas implementam vários métodos para maximizar a conversão:

Implementação mais rápida e menor custo Para parcelamento e assinaturas Para clientes sem cartão e valores altos Monitore todos os métodos em tempo real

🎯 Próximo Passo: Escolha um dos guias de integração acima e comece a processar pagamentos em menos de 20 minutos!

**Dúvidas?** Nossa [documentação completa](/concepts/overview) tem exemplos detalhados para todos os cenários.