API para parceiros conecta ERPs, CRMs e sistemas externos via REST v1, autenticação Bearer e webhooks assinados.
Ativar
1. Funcionalidades → API para parceiros
2. Setup em /produtos/partner_platform_api/setup
3. Gere chave em /api_keys
Endpoints REST v1
| Recurso | Caminho |
| Plataforma | GET /api/v1/platform |
| Consultas | GET /api/v1/appointments |
| Pacientes | GET /api/v1/patients |
| Faturas | GET /api/v1/invoices |
Autenticação: Authorization: Bearer hs_…
Webhooks
Cadastre URL HTTPS, segredo HMAC e eventos em /webhook_endpoints. Eventos: appointment.created, appointment.updated, appointment.validated, patient.created, invoice.paid.
Sobre o módulo
Chaves de API, webhooks e documentação REST v1..
Passos de configuração
1. Ativar módulo (feature_flags_path) — Habilite API para parceiros em Funcionalidades para esta clínica.
2. Gerar chave de API (api_keys_path) — Crie uma chave nomeada para o sistema externo (ERP, CRM ou integrador).
3. Cadastrar webhook (webhook_endpoints_path) — Informe a URL HTTPS que receberá eventos assinados (consultas, pacientes, faturas).
4. Validar integração (api_keys_path) — Teste uma chamada autenticada à API v1 e confirme que a resposta está correta.
Tour do gestor (FeatureSetups)
1. O que é a API para parceiros? — REST v1 com autenticação Bearer, recursos de consultas, pacientes e faturas, além de webhooks assinados para sincronização com ERPs e CRMs.
2. Ativar o módulo — Em Funcionalidades, ligue «API para parceiros». O módulo aparece na Suite com atalhos para chaves, webhooks e documentação JSON.
3. Criar e guardar a chave — Gere uma chave com nome descritivo (ex.: «ERP Clínica»). Copie o token na hora — ele não será exibido novamente. Compartilhe apenas com a equipe técnica do parceiro.
4. Configurar webhooks — Cadastre a URL de callback do parceiro, defina o segredo HMAC e selecione os eventos. Cada entrega é registrada nos logs de auditoria.
5. Consultar documentação — Acesse GET /api/v1/platform com Bearer token para obter versão, recursos e URLs base. Use o link «Documentação JSON» na tela de chaves.
6. Monitorar auditoria — Revise logs de auditoria para entregas de webhook e acessos via API. Revogue chaves comprometidas imediatamente.
Atalhos úteis
- Assistente de setup
- Webhooks
- Documentação API