Documentação da API

Tudo o que você precisa para integrar a plataforma de orquestração de pagamentos da BRAVIVE em suas aplicações.

Recursos da API

Precisa de Ajuda?

Nossa equipe de suporte ao desenvolvedor está disponível para ajudá-lo com qualquer dúvida de integração.

Primeiros Passos

Bem-vindo à documentação da API BRAVIVE. Nossas APIs permitem que você integre nossa plataforma de orquestração de pagamentos diretamente em suas aplicações, dando a você controle total sobre a experiência de pagamento.

Referência da API

Referência completa para todos os endpoints da API, parâmetros e respostas.

SDKs

Bibliotecas cliente oficiais para linguagens de programação populares.

Tutoriais

Guias passo a passo para cenários comuns de integração.

URL Base

https://api.bravive.com/v1

Todas as requisições da API devem ser feitas para esta URL base. HTTPS é obrigatório para todas as chamadas de API.

Autenticação

A BRAVIVE usa chaves de API para autenticar requisições. Você pode visualizar e gerenciar suas chaves de API no Painel da BRAVIVE.

curl -X GET https://api.bravive.com/v1/payments \
-H "Authorization: Bearer SUA_CHAVE_API"

Aviso de Segurança

Suas chaves de API possuem muitos privilégios, então certifique-se de mantê-las seguras. Não compartilhe suas chaves de API em áreas publicamente acessíveis como GitHub, código do lado do cliente, etc.

Todas as requisições de API devem ser feitas via HTTPS. Chamadas feitas via HTTP simples falharão. Requisições de API sem autenticação também falharão.

API de Pagamentos

A API de Pagamentos permite criar, recuperar, atualizar e listar transações de pagamento.

Criar um Pagamento

POST /v1/payments

{
  "amount": 1000,
  "currency": "USD",
  "payment_method": {
    "type": "card",
    "card": {
      "number": "4242424242424242",
      "exp_month": 12,
      "exp_year": 2025,
      "cvc": "123"
    }
  },
  "description": "Pagamento para o pedido #1234",
  "metadata": {
    "order_id": "1234",
    "customer_id": "cus_123456"
  }
}

Recuperar um Pagamento

GET /v1/payments/pay_123456789

API de Processadores

A API de Processadores permite gerenciar e configurar os processadores de pagamento conectados à sua conta BRAVIVE.

Listar Processadores

GET /v1/processors

Webhooks

Webhooks permitem receber notificações em tempo real sobre eventos que acontecem em sua conta BRAVIVE.

Eventos de Webhook

BRAVIVE pode enviar eventos de webhook para o seguinte:

payment.succeeded
payment.failed
payment.refunded
processor.switched
processor.down
processor.up

Exemplo de Payload de Webhook

{
  "id": "evt_123456789",
  "object": "event",
  "type": "payment.succeeded",
  "created": 1647359065,
  "data": {
    "object": {
      "id": "pay_123456789",
      "object": "payment",
      "amount": 1000,
      "currency": "USD",
      "status": "succeeded",
      "description": "Pagamento para o pedido #1234",
      "payment_method": {
        "type": "card",
        "card": {
          "brand": "visa",
          "last4": "4242",
          "exp_month": 12,
          "exp_year": 2025
        }
      },
      "metadata": {
        "order_id": "1234",
        "customer_id": "cus_123456"
      },
      "created": 1647359065,
      "processor": "processor_a"
    }
  }
}

Tratamento de Erros

BRAVIVE usa códigos de resposta HTTP convencionais para indicar o sucesso ou a falha de uma requisição de API.

Código	Descrição
200 - OK	Tudo funcionou como esperado.
400 - Requisição Inválida	A requisição foi inaceitável, geralmente devido à falta de um parâmetro obrigatório.
401 - Não Autorizado	Nenhuma chave de API válida fornecida.
404 - Não Encontrado	O recurso solicitado não existe.
429 - Muitas Requisições	Muitas requisições atingiram a API muito rapidamente.
500, 502, 503, 504 - Erros do Servidor	Algo deu errado no lado da BRAVIVE.

Limites de Taxa

A API BRAVIVE implementa limites de taxa para proteger nossa infraestrutura e manter a qualidade do serviço para todos os usuários.

Limites Atuais

Os limites de taxa atuais são:

100 requisições por minuto para endpoints de API padrão
10 requisições por minuto para operações pesadas (por exemplo, geração de relatórios)

Se você exceder esses limites, receberá uma resposta 429 Too Many Requests. A resposta incluirá um cabeçalho Retry-After indicando quanto tempo esperar antes de fazer outra requisição.

Pronto para Começar a Integrar?

Crie uma conta de desenvolvedor para obter suas chaves de API e comece a construir com a BRAVIVE.

Criar Conta de Desenvolvedor Ver Tutoriais