Skip to content

BobPayments/documentation

Repository files navigation

Bob Payments Logo

Bob Payments Documentation

Contributions Welcome

Bob Payments é um orquestrador de pagamentos PIX para desenvolvedores. Em vez de integrar e manter cada gateway individualmente, você conecta uma única API e nós cuidamos do roteamento, fallback e disponibilidade. Built by developers for developers, it offers:

  • Múltiplos gateways PIX por trás de uma única API
  • QR Code e código copia-e-cola gerados em uma chamada
  • Notificações em tempo real via webhooks com verificação HMAC-SHA256
  • Sandbox completo para simular pagamentos sem mover dinheiro real
  • Respostas JSON consistentes em todos os endpoints
  • Autenticação simples via Bearer Token

🚀 Quick Start

Esta documentação é construída com Mintlify.

  1. Visualizar localmente
# Instalar o CLI do Mintlify
npm i -g mintlify

# Iniciar o servidor de desenvolvimento
mintlify dev
  1. Acesse http://localhost:3000 para ver a documentação

📚 Estrutura

.
├── pages/
│   ├── introduction.mdx        # Visão geral da API
│   ├── devmode.mdx             # Ambiente sandbox
│   ├── authentication.mdx      # Autenticação Bearer Token
│   ├── webhooks.mdx            # Webhooks e verificação de assinatura
│   ├── production.mdx          # Guia para ir a produção
│   ├── pix/                    # Cobranças PIX
│   ├── customers/              # Gestão de clientes
│   └── store/                  # Dados da loja
├── docs.json                   # Configuração do Mintlify
└── openapi.yaml                # Especificação OpenAPI (gerada automaticamente)

🔧 Desenvolvimento local

mintlify dev

Se o servidor não iniciar, execute mintlify install para reinstalar as dependências.

🚀 Deploy

As alterações são publicadas automaticamente quando mescladas na branch main, via integração do Mintlify com o GitHub.

💪 Suporte

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Generated from mintlify/starter