Skip to main content
A API pública do ByDoctor dá às clínicas e aos fornecedores de software que as atendem acesso programático aos agendamentos e ao cadastro de pacientes da clínica — para sincronizar dados com um sistema próprio, alimentar um BI interno, reagir a mudanças de agenda em tempo real ou marcar consultas a partir de outro sistema. Cada chave é Somente leitura (ler agendamentos e pacientes) ou Acesso total (também cadastrar pacientes e criar, alterar e cancelar agendamentos presenciais), escolhido na criação. Webhooks avisam de toda mudança de agendamento, venha ela do aplicativo, do paciente ou da API.

Primeiros passos

Crie uma chave de API e faça a primeira chamada em poucos minutos.

Autenticação

Formato da chave, escopos, limites de uso e boas práticas de segurança.

Agendamentos

Listar, criar, alterar e cancelar; filtros e paginação por cursor.

Pacientes

Encontrar pelo CPF ou telefone, cadastrar e alterar pacientes para agendar.

Webhooks

O envelope de evento, os três tipos de evento e a política de reentrega.
Resumo rápido
  • Base URL: https://api.bydoctor.com.br/api/public/v1
  • Autenticação: Authorization: Bearer bd_live_<id>.<secret>
  • Escopos: appointments:read, patients:read, appointments:write e patients:write, por chave
  • Formato: JSON, UTF-8, horários em America/Sao_Paulo (-03:00)
  • Limites: 60 requisições/min e 10.000 requisições/dia por chave
  • Eventos de webhook: appointment.created, appointment.updated, appointment.cancelled

​
Como a API se encaixa

  • Agendamentos (/agendamentos): consulte a agenda da clínica por período, status, profissional, paciente, sala ou modalidade, com paginação por cursor; crie, altere e cancele agendamentos presenciais com o escopo de escrita.
  • Pacientes (/pacientes): encontre o paciente pelo CPF ou telefone e cadastre-o se não existir, para usar o id na criação de agendamentos. CPF, e-mail e data de nascimento são gravados, mas nunca devolvidos.
  • Profissionais (/profissionais), Salas (/salas) e Tipos de atendimento (/tipos-de-atendimento): os ids que a criação de agendamentos pede, em listas somente leitura com o mínimo de dados.
  • Sincronização (/sincronizacao): a receita recomendada para manter uma cópia local da agenda em dia, combinando updated_since com webhooks.
  • Webhooks (/webhooks): receba appointment.created, appointment.updated e appointment.cancelled assim que acontecem, com entrega pelo menos uma vez (at-least-once) e reentrega automática.
  • Verificação de assinatura (/verificacao-de-assinatura): valide a origem de cada evento recebido usando o padrão Standard Webhooks.
As chaves de API são criadas dentro do próprio ByDoctor, em Minha Clínica → API e Webhooks, e concedem acesso a dados de pacientes e de agendamentos — trate-as como um segredo de produção.