Pular para o conteúdo

Referência da API

276 operações em 27 grupos, geradas do contrato OpenAPI 1.0.0.

Sistema

Saúde do serviço (sem autenticação).

Cadastro

Autocadastro da clínica pelo próprio dono: clínica, acesso de administrador e teste grátis do plano numa chamada idempotente.

Sessão

Usuário autenticado, clínicas acessíveis e contexto ativo.

Clínica

Dados da clínica ativa e logo. Admin da plataforma: cadastro de tenants.

Usuários

Vínculos (memberships), perfis de acesso e convites.

Pacientes

Cadastro, ficha, evoluções (prontuário) e tarefas.

Serviços

Cadastro de serviços — fonte única do painel.

Profissionais

Equipe que atende e disponibilidade.

Agenda

Agendamentos/sessões: criar, confirmar, reagendar, cancelar com motivo, marcar realizada/falta.

Leads

CRM e funil: etapas, mover com motivo, próxima ação, conversão.

Comunicação

Caixa de entrada omnichannel: conversas, mensagens, assumir/devolver ao agente.

Agentes

Time de agentes da clínica: status, pausar/retomar, execuções, tentar de novo.

Aprovações

Ações propostas por agentes aguardando decisão humana.

Execução ao vivo

Passos de uma execução de agente em andamento: publicação pelo agente (token de serviço) e acompanhamento pelo painel (Server-Sent Events), sem conteúdo das mensagens.

Automações

Catálogo de add-ons, contratar, testar 7 dias, desativar (cobrança proporcional).

Plano e assinatura

Plano, uso, próxima fatura, faturas, mudar plano, cancelar.

Financeiro

Transações (fonte explícita — PRD §17.1), a receber, a pagar, resumo.

Fiscal

Emissor de NFS-e da clínica via provedor de emissão: configuração com aprovação do contador, regras versionadas por serviço, fila de revisão gerada pela Agenda, lotes com prévia, modos Simulação/Homologação/Produção (Produção travada por portão e confirmação por ação), histórico por tentativa, XML/PDF imutáveis e webhook do provedor.

Onboarding

Fora do escopo do projeto (decisão do dono em 26/09/2026): o onboarding conversacional com a Renata não faz parte do produto publicado; código mantido, desligado por padrão (ONBOARDING_RENATA_ENABLED=false) e fora do deploy. Descrição original, mantida por referência: sessão da clínica (uma por clínica), mensagens com um turno por vez, polling, "tentar de novo" com o mesmo evento, progresso com versão otimista e as rotas da própria Renata (contexto, respostas e propostas de fato). Perfil da clínica: fatos por chave com aprovação humana (aprovar, editar, rejeitar, informar, revogar) com versão otimista, e a conclusão do onboarding.

Entrevista da dona

Entrevista da Lívia com a dona da clínica pelo WhatsApp: catálogo versionado de 44 perguntas (owner-interview-v1) e progresso por pergunta da clínica, com máquina de estados validada no servidor, versão otimista (If-Match) e rascunho criptografado. Aprovar é só de pessoa da clínica.

Conhecimento

Base de conhecimento por clínica, governança de uso por IA e revisão.

Integrações

Conectar/desconectar/testar, sincronização e histórico. Segredos nunca são devolvidos.

Auditoria

Histórico de ações (append-only), filtros e exportação CSV.

Relatórios

Endpoints agregados usados pelas abas de Relatórios e pela Home.

Privacidade

Pedidos LGPD do próprio usuário.

Notificações

Balcão do dono