Integrações

Conecte o TI do cliente à plataforma: receba eventos em tempo real, envie a lista de elegíveis, e consuma os relatórios de vacinados para gestão e BI.

Olá, —

notifications_active

Webhooks em tempo real

Receba um POST HTTP assinado (HMAC-SHA256) a cada aplicação registrada, estorno, importação concluída ou campanha encerrada — sem ficar consultando.

monitoring

Relatórios & BI (pull)

Consulte a tabela verdade (elegível × vacinado × pendente) e a carteira por CPF via token de leitura — pronto para Power BI, Tableau ou Data Studio.

tune

Contexto

Escolha a campanha do cliente. Ela define o escopo dos tokens e webhooks abaixo.

Campanha / cliente

Base da API—

vpn_key

Autenticação

Toda chamada da API externa usa um token Bearer no cabeçalho Authorization. O token é exibido uma única vez na emissão — guarde-o em cofre de segredos.

GET /parceiro/carteira/52998224725 HTTP/1.1 Host: seu-dominio Authorization: Bearer SEU_TOKEN Content-Type: application/json

1key

Tokens de API

Emita o token conforme o uso. Leitura/BI = escopo do cliente; envio de elegíveis e app in company = escopo da campanha selecionada.

Tipo de token

Token (copie agora — não será exibido de novo):

2sync

Webhooks (tempo real)

Registre uma URL https para receber eventos do cliente selecionado. Cada entrega traz o header X-Assinatura = HMAC-SHA256 do corpo, com o segredo mostrado na criação.

Evento

URL de destino (https)

api

Endpoints da API externa

Base: — · Autenticação: Authorization: Bearer <token>

Método / Rota	Para que serve	Token
GET `/parceiro/campanhas/{id}/tabela-verdade`	Relatório de vacinados × elegíveis × pendentes (analítico) — gestão e BI	consulta
GET `/parceiro/carteira/{cpf}`	Carteira/histórico de vacinação de um CPF (perpétua)	consulta
POST `/parceiro/campanhas/{id}/elegiveis`	Enviar/atualizar elegíveis em lote (RH → plataforma)	ingestao_b2b
POST `/parceiro/campanhas/{id}/elegiveis/sincronizar`	Sincronizar (remove quem saiu da lista — turnover)	ingestao_b2b
GET `/parceiro/campanhas/{id}/elegiveis/{cpf}`	Consultar situação de um elegível	ingestao_b2b
POST `/parceiro/aplicacoes`	Registrar aplicação (vacinação) — app/terceiro	app_in_company
POST `/parceiro/aplicacoes-lote`	Registrar várias aplicações de uma vez	app_in_company

info

Paginação por cursor (?apos=<cursor>) para grandes volumes; idempotência de escrita via header Idempotency-Key. Datas em ISO-8601. CPF pode ser mascarado conforme a permissão do token/cliente.

Exemplo — enviar elegíveis (ingestao_b2b)

POST /parceiro/campanhas/123/elegiveis Authorization: Bearer SEU_TOKEN { "elegiveis": [ { "cpf": "52998224725", "nome": "Maria Silva", "data_nascimento": "1990-05-10", "tipo_vinculo": "colaborador", "codigo_lotacao": "LOT-01", "codigo_rh": "RH-1001" } ] }

insights

Conectar o Power BI

Gere um token do tipo consulta (seção 1).
No Power BI: Obter dados → Web → Avançado.
URL: —
Cabeçalho HTTP: Authorization = Bearer SEU_TOKEN.
Atualize periodicamente (agendamento do Power BI). Para grandes volumes, pagine com ?apos=.