Central de ajuda

API e webhooks (integrações)

Ligar o site, o CRM ou o BI da clínica à agenda e aos pacientes, com chaves de API e avisos automáticos.

A API deixa outros sistemas da clínica (site com agendamento online, CRM, painel de BI, chatbot) consultarem e cadastrarem pacientes, verem horários livres e agendarem, sem ninguém digitar duas vezes. O prontuário nunca sai pela API. Ela faz parte dos planos com integrações.

Criar uma chave

  1. Configurações › API e webhooks › Criar chave.
  2. Dê um Nome (por exemplo, "Site da clínica") e marque só as Permissões de que esse sistema precisa.
  3. Escolha a Validade. Se quem integra informar os IPs do servidor, preencha Só destes IPs.
  4. Criar chave e Copiar. Ela aparece uma única vez: envie para quem faz a integração por um canal seguro (cofre de senhas), nunca por e-mail aberto ou grupo de WhatsApp.

Cada sistema deve ter a sua chave. Quem integra encontra a documentação em axiclinic.com/desenvolvedores.

Revogar

Clique em Revogar na chave. O sistema que a usava perde o acesso na hora. Faça isso quando trocar de fornecedor, quando alguém que tinha a chave sair da equipe ou se ela vazar.

Webhooks (avisos automáticos)

O webhook avisa o sistema da clínica na hora em que algo acontece: consulta agendada, remarcada, confirmada ou cancelada, paciente cadastrado ou alterado.

  1. Cadastrar webhook: cole o Endereço (https) que quem integra passar e marque os eventos em Avisar quando.
  2. Copie o Segredo de assinatura e envie para quem integra (ele não aparece de novo).
  3. Enviar teste e confira em Últimos envios se chegou.

Se o endereço falhar sem parar por 3 dias, o sistema desliga o webhook e mostra o aviso. Depois de corrigido, clique em Religar.

Uso e limites

O topo mostra as Requisições hoje e o Ritmo máximo do plano (todas as chaves somadas). Quando o limite chega, o sistema que integra recebe "aguarde" e tenta de novo depois. Precisa de mais? Veja os planos em Minha assinatura.

Só o dono e o administrador abrem esta tela. Toda criação e revogação de chave fica na auditoria.

Mais sobre Configurações