Pular para o conteúdo principal
Toda chamada, exceto GET /v1/health, precisa da chave no cabeçalho X-API-Key.

​
Criar a chave

  1. No Controle Clinic, abra Configurações → Clínica → Integrações → Tokens de API.
  2. Dê um nome que diga onde a chave será usada (ex.: “Integração n8n”).
  3. Marque só os escopos de que a integração precisa.
  4. Defina uma validade.
A chave tem o formato cc_live_ seguido de 64 caracteres. Ela pertence a uma clínica: tudo o que a chave lê ou grava é dessa clínica.
A chave dá acesso aos dados da clínica. Guarde-a no cofre de segredos da sua ferramenta (n8n, servidor, CRM), nunca em código no navegador nem em planilha compartilhada.

​
Escopos

Sem sensitive:read, os dados pessoais dos pacientes saem mascarados, e no financeiro esses campos nem aparecem na resposta. Confira os escopos de cada rota na aba Referência da API.

​
Conferir a chave

GET /v1/me devolve o prefixo, o nome, os escopos, a validade e a clínica da chave em uso. É a primeira chamada a fazer numa integração nova.

​
Auditoria

Toda chamada fica registrada em Logs de Auditoria, na mesma tela dos tokens.