Integrações
API pública e webhooks
Chaves de acesso com escopo para integrações e avisos assinados para os sistemas da clínica. A documentação técnica fica na página de desenvolvedores.
Revisado em
Onde fica no sistema
- Configurações › Integrações
Em Configurações › Integrações ficam a API pública (chaves que dão a um robô ou integração acesso à agenda desta clínica, com escopo e uso registrado) e os Webhooks (avisos para os sistemas da clínica quando algo acontece aqui).
Os dois ficam desligados até a clínica configurar: sem chave criada, ninguém acessa a API; sem endereço cadastrado, nenhum webhook sai. Se a API estiver desligada no servidor da plataforma, as chamadas respondem como indisponíveis.
Autenticação, escopos, rotas, erros, limites, eventos e a verificação da assinatura dos webhooks estão explicados na página Desenvolvedores, no rodapé do site.
Atenção: Trate a chave da API como uma senha: ela aparece uma vez só. Se vazar, revogue e crie outra.
No sistema: Configurações › Integrações