Read API & Webhooks
Seus dados, legíveis por você. Não presos atrás de um dashboard.
Agências cuidam de muitos tenants e precisam de acesso programático: feeds de status de conversão, agregados por campanha, recibos de entrega. Tokens com escopo retornam agregados por tenant, webhooks empurram mudanças de status em tempo real, e todo payload pode ser reproduzido pelo id de entrega.
Páginas marcadas como Planejada são especificações completas escritas antes de o conector existir. Elas validam a demanda. Conectores com logs reais de entrega estão marcados como Produção ou Beta.
Relatório por screenshot não escala
Sem acesso de leitura, cada relatório de cliente significa logar em outro dashboard. Dado que você pagou para gerar não deveria exigir exportação manual para ser útil.
Um contrato determinístico para todos os tenants que você atende
Leia agregados agrupados por campanha ou janela, receba webhooks quando resultados confirmam ou retraem, e alimente seu BI e relatórios de cliente pela mesma fonte que as plataformas de anúncio veem.
- 01Agency connects one workspace covering all its tenants
- 02Scoped read token returns aggregates, never raw patient data
- 03Webhooks push conversion status changes as they happen
- 04Dashboards and reports read from one deterministic contract
- 05Every payload is idempotent and replayable by delivery id
Crie um token de leitura com escopo no workspace (só agregados, sem registros brutos).
Assine os webhooks conversion.delivered, conversion.failed, outcome.confirmed e outcome.retracted.
Consulte ou escute; todo evento carrega um id de entrega reproduzível.
Aponte seus dashboards para os mesmos números que as plataformas de anúncio recebem.
| From | Apointo |
|---|---|
| GET /v1/conversions?tenant=&window= | conversion_status_feed |
| GET /v1/aggregates?groupBy=campaign | campaign_aggregates |
| Webhook: conversion.delivered / conversion.failed | delivery_receipts |
| Webhook: outcome.confirmed / outcome.retracted | tenant_event_stream |
Tenants leem dados brutos de pacientes por ali?
Não. A superfície de leitura serve agregados e status por design. Registros clínicos ficam no dashboard do tenant sob os controles de acesso existentes.
Qual a diferença da API de Conversões?
A API de ingestão escreve resultados no Apointo. Esta superfície lê de volta. Elas saem juntas para o dado nunca fluir num só sentido.
Quando isso sai?
Junto com a API de Conversões. As inscrições de acesso antecipado definem a ordem de construção.