Uma API é uma interface que permite que dois sistemas se comuniquem por meio de requisições e respostas.
Ela define como um sistema pode ser acessado, quais dados podem ser enviados e quais informações serão recebidas.
Exemplo: se o cliente quer integrar dados dos procedimentos, paciente, profissional com algum software externo. Se a clínica quer enviar dados para outro sistema de marketing por exemplo, tudo pode ser feito através da criação de uma API que exporta os dados automaticamente.
Um webhook é um gatilho automático que envia informações de um sistema para outro quando algo acontece.
Você registra uma URL no sistema, e ele notifica automaticamente quando um evento ocorre.
Imagine que eu tenho um ERP que não pertence à clínica, mas quero que esse ERP seja notificado sempre que um paciente for agendado. Para isso, o sistema da clínica envia automaticamente uma notificação (webhook) para esse outro software, informando que um novo agendamento foi criado.
API e Webhook
Para acessar as configurações de API e Webhooks, siga estas instruções:
Abrirá a página que mostra as chaves de API existentes.
Para consultar a documentação completa da API, clique em 'Acessar Documentação', no canto superior direito da tela.