API pública e webhooks da ByDoctor
A ByDoctor tem uma API REST pública para conectar a agenda da clínica a outros sistemas — ERPs, CRMs, BI interno, apps próprios. Ela foi pensada para o time técnico da clínica ou para parceiros que constroem uma integração sob demanda, sem depender de exportações manuais. A versão atual (v1) é somente leitura: lista e consulta agendamentos com filtros, incluindo sincronização incremental por updated_since, para saber o que mudou desde a última chamada sem reprocessar tudo. Para reagir a mudanças no momento em que elas acontecem, webhooks assinados notificam criação, atualização e cancelamento de agendamentos. Toda escrita — criar, editar ou cancelar uma consulta — continua pelo aplicativo ByDoctor; a API cobre a leitura e o aviso em tempo real. A autenticação é feita por chave de API, gerada dentro do próprio produto e exibida uma única vez no momento da criação.
Última atualização: 4 de agosto de 2026 · A referência completa, com todos os endpoints, parâmetros e exemplos, fica em docs.bydoctor.com.br.
Resumo técnico
- Base URL
- https://api.bydoctor.com.br/api/public/v1
- Autenticação
- Chave de API (Authorization: Bearer bd_live_...)
- Formato
- JSON, UTF-8, horários em America/Sao_Paulo (-03:00)
- Limites
- 60 req/min e 10.000 req/dia por chave
- Webhooks
- appointment.created, appointment.updated, appointment.cancelled
- Assinatura
- Standard Webhooks (webhook-id, webhook-timestamp, webhook-signature)
O que dá para fazer
Com uma única chave de API, uma integração típica cobre três cenários:
Listar e filtrar agendamentos por período, profissional, status e paciente
Sincronizar de forma incremental com o parâmetro updated_since, sem precisar reprocessar tudo a cada chamada
Receber eventos em tempo real por webhook assim que um agendamento é criado, atualizado ou cancelado
Perguntas frequentes
O ByDoctor tem API?
Sim. A ByDoctor tem uma API REST pública para agendamentos e um sistema de webhooks em tempo real, pensados para clínicas que querem integrar a agenda a sistemas próprios ou de terceiros.
A API permite criar ou alterar agendamentos?
Não hoje. A v1 é somente leitura: lista e detalha agendamentos, com filtros e sincronização incremental por updated_since. Criação e alteração de agendamentos continuam sendo feitas pelo aplicativo ByDoctor.
Como faço para obter uma chave de API?
Dentro do produto, em Minha clínica → API e Webhooks. A chave (Authorization: Bearer bd_live_...) é exibida uma única vez no momento da criação — copie e guarde-a com segurança.
Os webhooks são assinados?
Sim. Cada entrega segue o padrão Standard Webhooks, com os cabeçalhos webhook-id, webhook-timestamp e webhook-signature, permitindo validar a autenticidade e a integridade do payload antes de processá-lo.
Documentação completa
Esta página é um resumo. Endpoints, parâmetros de filtro, exemplos de requisição, esquema completo dos payloads de webhook e o passo a passo de configuração ficam na referência técnica, em docs.bydoctor.com.br — atualizada a cada mudança na API.