O que podes fazer
- Gestão de perfis — Cria, obtém e atualiza perfis demográficos de pacientes.
- Agendamento de marcações — Agenda marcações de colheita de sangue em locais de análise da Aniva.
- Gestão de painéis — Adiciona ou remove painéis de análises laboratoriais numa marcação existente.
- Biomarcadores individuais — Associa ou desassocia biomarcadores individuais numa marcação sem escolher um painel.
- Pedidos de kits de teste em casa — Envia um kit de teste em casa por correio a um paciente, acompanha as respetivas encomendas e comunica quando a amostra foi colhida.
- Catálogo de painéis — Explora os painéis disponíveis com
GET /api/v1/panelspara descobrir os IDs dos painéis e os biomarcadores incluídos. - Catálogo de biomarcadores — Explora os biomarcadores que podes pedir num local de análise ou num kit de teste em casa com
GET /api/v1/biomarkerspara descobrir os IDs. - Confirmação de colheita de sangue — Submete o(s) código(s) de laboratório após uma colheita para acionar o pipeline de pedidos laboratoriais.
- Resultados laboratoriais — Obtém resultados clínicos e genéticos e transfere os PDFs dos relatórios laboratoriais.
- Descoberta de locais — Lista os locais de análise disponíveis para apresentar aos pacientes.
- Logística de envios — Cria, acompanha, modifica e cancela pedidos de envio por transportadora.
- Webhooks — Recebe uma chamada HTTPS quando uma marcação, um pedido de kit de teste em casa, os respetivos resultados, um local, um perfil ou um envio muda. Consulta Webhooks.
Explora a documentação
Autenticação
Autentica pedidos com a tua chave de API de parceiro.
Início rápido
Faz a tua primeira chamada à API em minutos com exemplos passo a passo.
Perfis
Aprende como funcionam os perfis de pacientes e que dados guardam.
Marcações
Compreende o ciclo de vida de uma marcação, do agendamento à confirmação.
Pedidos de kits de teste em casa
Envia um kit de teste para casa de um paciente e acompanha-o até a amostra chegar ao laboratório.
Versões da API
A versão atual da API é v1. Todos os endpoints têm o prefixo/api/v1/. O URL base é https://anivahealth.com.
Datas e fusos horários
Todos os instantes transmitidos estão em UTC ISO 8601 (sufixoZ). Os campos apenas de calendário usam componentes de relógio
local (YYYY-MM-DD, HH:MM).
Notas específicas:
- Entradas que aceitam data e hora (p. ex.
scheduled_atemPOST/PATCH /api/v1/appointments) têm de incluir um designador de fuso horário — sejaZou um desvio explícito como+02:00. Datas e horas sem fuso horário são rejeitadas com400. Ambas as formas codificam o mesmo instante; a resposta devolve semprescheduled_atem UTCZ. Usa o campotimezonedo local (ou qualquer outro identificador IANA) para formatar o instante na hora local ao apresentá-lo. - Entradas de relógio local são interpretadas no fuso horário do recurso a que se destinam: as datas de
disponibilidade usam o parâmetro de consulta
timezone(por predefinição, o fuso horário do local);pickup_date/pickup_time_*do envio são interpretados no fuso horário do local de origem. - Campos de resposta apenas de data (p. ex.
tested_at,availability[].datede disponibilidade) são datas de calendário sem fuso horário.
Obter acesso
As chaves de API são emitidas por parceiro pela Aniva.Contacta a Aniva para receberes a tua chave de API de parceiro.