v1 · Estável
API do BoltzApp
Integre o Boltz à sua aplicação via API REST. Endpoints públicos para agendamento, gestão e webhooks.
Visão geral
A API do BoltzApp é uma API REST com respostas em JSON. Todos os endpoints estão sob https://boltz.app.br/api/v1/ e o suporte a CORS é configurado por ambiente.
Autenticação
Endpoints de leitura pública não requerem autenticação. Endpoints autenticados usam sessão via NextAuth. Especificações de acesso para integrações privadas são tratadas caso a caso.
Endpoints principais
- GET
/api/v1/public/organizations/:slugRetorna dados públicos do estabelecimento e catálogo - GET
/api/v1/public/providers?organizationSlug=:slugLista prestadores públicos do estabelecimento - GET
/api/v1/public/time-slots?organizationSlug=:slug&providerId=:id&date=YYYY-MM-DDConsulta horários disponíveis para agendamento - GET
/api/v1/public/plansLista planos públicos disponíveis
Webhooks
Receba notificações em tempo real sobre eventos: agendamento criado, confirmado, cancelado e atualizado. Configuração via painel administrativo.
Limites
- Quotas e rate limits variam por ambiente e tipo de integração
- A especificação operacional completa é compartilhada na documentação comercial
- Para integrações críticas, consulte o time antes de produção
Documentação completa
Para integrações comerciais, especificação OpenAPI completa e acesso a chaves de API, fale com o time pelo WhatsApp.
Falar com o time