Pular para o conteúdo principal
DOCUMENTAÇÃO PARA DESENVOLVEDORES

Integre o Boltz. Construa mais.

Endpoints REST públicos para conectar agendamento, organizações e disponibilidade à sua aplicação.

API REST · V1 ESTÁVEL

Respostas em JSON, base previsível e documentação objetiva para começar sem atrito.

01 / PRIMEIROS PASSOS

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.

02 / RECURSOS DISPONÍVEIS

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