Marcar análises ao sangue a partir do teu próprio produto

Uma chave de API dá-te 45 endpoints, desde a marcação aos resultados de laboratório

A Aniva Partner API marca uma colheita de sangue em mais de 25 localizações na Alemanha, adiciona painéis a essa marcação e devolve resultados clínicos e genéticos em JSON. Cada pedido precisa de um cabeçalho e o URL base é o mesmo em todos os ambientes.

Quando usar a Aniva

Usa a Aniva quando os teus clientes precisarem de marcar uma análise ao sangue
Usa os endpoints de marcação para uma colheita de sangue em clínica e os endpoints de kit de teste em casa para um kit por correio.
Usa os endpoints de resultados para as linhas clínicas, as linhas genéticas e o relatório em PDF.
Usa os endpoints de catálogo para consultar os biomarcadores, painéis e unidades que a Aniva vende.
Usa os caminhos documentados em https://anivahealth.com/api/v1/ e não inventes endpoints.
POST /api/v1/appointments
curl --request POST \
  --url https://anivahealth.com/api/v1/appointments \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
    "scheduled_at": "2026-05-15T12:30:00+02:00"
  }'
O fluxo básico tem quatro pedidos
GET /locations POST /profiles POST /appointments POST /appointments/{id}/confirm
45

45 endpoints estão documentados e ativos hoje

1

A autenticação precisa apenas de um cabeçalho de pedido

v1

Cada caminho começa com o prefixo v1

25+

Os locais na Alemanha podem fazer a colheita de sangue

Quatro pedidos criam uma integração funcional

Quatro pedidos vão da marcação aos resultados do laboratório

Cada pedido devolve o ID de que o seguinte precisa, pelo que uma integração básica consiste em quatro pedidos antes de adicionares painéis, reagendamentos ou estafetas.

Passo 01 · GET /locations

Listas os locais onde a tua chave pode marcar

A resposta dá-te cada morada, o horário de funcionamento e o fuso horário, para que um cliente veja apenas horários que existem.

Análises
Passo 02 · POST /profiles

Crias um perfil para o cliente

Um perfil precisa de um nome, um código de sexo, uma data de nascimento e do teu profile_group, que aceita um UUID ou o teu próprio slug.

Análises
Passo 03 · POST /appointments

Fazes a marcação num horário à tua escolha

A marcação precisa do ID do perfil, do ID do local e de uma data e hora ISO 8601 com o respetivo desfasamento ou o sufixo Z.

Análises
Passo 04 · POST /appointments/{id}/confirm

Confirmas a colheita de sangue com o código de barras do kit

Este pedido inicia a requisição ao laboratório e bloqueia a marcação, por isso altera todos os painéis antes de o enviares.

Análises
POST /api/v1/appointments
curl --request POST \
  --url https://anivahealth.com/api/v1/appointments \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
    "scheduled_at": "2026-05-15T12:30:00+02:00"
  }'
Capacidade

Cada grupo de recursos é uma coleção REST

Podes pedir uma colheita de sangue numa clínica ou um kit de teste em casa por correio. Ambos chegam no mesmo formato, por isso só escreves uma vez o código que lê os resultados.

Perfis · 4 endpoints

Um perfil é a pessoa que testas

Procuras um perfil por email, crias o perfil no teu grupo de perfis e atualizas os dados demográficos mais tarde.

Análises
GET /profiles
PATCH /profiles/{id}
Marcações · 15 endpoints

Uma marcação tem os painéis e a colheita de sangue

Quinze endpoints cobrem a marcação e todas as alterações posteriores, incluindo painéis, pré-visualizações de recipientes e a confirmação.

Análises
POST /appointments
GET /appointments/{id}/results
Encomendas de kits de teste em casa · 10 endpoints

As encomendas de kit de teste em casa são a versão por correio

Dez endpoints pedem um kit DIY para um perfil, alteram os seus painéis e devolvem a mesma estrutura de resultado.

Análises
Criar encomenda de kit
Obter resultados
Localizações · 2 endpoints

Os locais indicam-te onde acontece uma colheita de sangue

Lês os locais que a tua chave permite marcar e depois pedes a um deles os horários de início disponíveis.

Análises
GET /locations
GET /locations/{id}/availability
Documentos · 1 endpoint

Os resultados chegam em linhas clínicas e genéticas

Cada tipo de pedido tem a sua própria chamada de resultados, e o relatório em PDF é uma transferência separada por ID de ficheiro.

Análises
GET /appointments/{id}/results
GET /documents/{id}
Envios · 8 endpoints

Um estafeta leva a amostra ao laboratório

Crias um pedido de estafeta com uma janela de recolha num dia útil, depois associas marcações e lês as atualizações de estado.

Análises
POST /shipments
Associar marcações
Catálogos · 4 endpoints

Os catálogos listam os biomarcadores que podes pedir

Os catálogos de biomarcadores, painéis e unidades estão paginados e podes filtrar os biomarcadores por local de análise.

Análises
GET /biomarkers
GET /panels
Saúde · 1 endpoint

Um endpoint de prontidão não precisa de chave API

A sonda de prontidão não precisa de chave de API, pelo que o teu monitor de disponibilidade pode chamá-la de forma agendada.

Análises
Sonda de prontidão pública
O teu trabalho termina na confirmação do código de barras

O processo laboratorial começa quando confirmas a colheita de sangue

Envias-nos o código de barras do kit e é a última coisa de que precisamos da tua parte. Depois organizamos os recipientes, a transportadora e o laboratório, por isso o teu código só chama dois endpoints até o relatório ficar pronto.

The Aniva lab pipeline from confirmation to results Confirming the draw is followed by container selection, courier collection and laboratory analysis, and each biomarker row then reads as planned, received or fault. POST /appointments/{id}/confirmYou confirm the draw GET /appointments/{id}/previewContainers are known POST /shipmentsA courier collects it Aniva laboratory networkThe laboratory analyses planned received fault GET /appointments/{id}/results
Um ponto preenchido é o percurso que queres.Um anel é um estado que ainda tens de gerir.As linhas laranja são o pedido confirmado.
Um único parser lê uma colheita na clínica e um kit de teste em casa

Cada resultado tem dois intervalos de referência e quatro estados

Cada linha clínica inclui o intervalo comunicado pelo laboratório e o intervalo da Aniva com a sua janela ótima, para que possas apresentar ambos sem manteres a tua própria tabela de referência.

Uma linha mostra planeado antes de o laboratório a analisar.
Uma linha aparece como recebida assim que chegam um valor e uma unidade.
Uma linha indica fault quando o laboratório cancelou o pedido, e status_reason explica o motivo.
GET /api/v1/appointments/{id}/results
{
  "status": "in_progress",
  "clinical_results": [{
    "status": "received",
    "biomarker_name": "Vitamin D",
    "value": 38.5, "unit": "ng/mL",
    "reference_range_lab": { "normal_min": 30, "normal_max": 100 },
    "reference_range_aniva": { "optimal_min": 40, "optimal_max": 60 },
    "tested_at": "2026-04-05"
  }],
  "documents": [{ "file_name": "lab-report-2026-04-05.pdf" }]
}
A API usa três formatos de hora

As datas e horas precisam de um fuso horário ou o pedido falha

Uma data e hora sem fuso horário é rejeitada com 400, o erro mais comum nas primeiras integrações.

Os registos de data e hora vêm sempre em UTC, usando ISO 8601 com o sufixo Z.
Os dados de entrada têm de incluir um desfasamento horário explícito, pelo que uma marcação aceita 2026-05-15T12:30:00+02:00.
As atualizações de envio mantêm o desfasamento comunicado pelo operador logístico.
Os campos de calendário indicam apenas a data local, como uma data de nascimento.
A Aniva emite e roda cada chave de parceiro

Cada pedido precisa da tua chave de API de parceiro

A autenticação usa o cabeçalho x-api-key em cada chamada, e uma chave em falta ou substituída devolve 403 com um breve erro JSON.

A tua chave decide que locais, marcações e envios podes ver.
Nunca exponhas a tua chave de API em código do lado do cliente nem em repositórios públicos.
Uma sonda pública não precisa de chave API

Podes acompanhar cada serviço na página de estado

A página de estado mostra o estado atual e 90 dias de histórico para cada serviço, e os mesmos dados estão disponíveis em JSON para o teu próprio monitor.

As chaves de parceiro são emitidas pela nossa equipa

Pedir-nos uma chave de parceiro hoje

Diz-nos em que mercados vendes e de que painéis precisas, e enviamos-te uma chave com as permissões certas.

Também podes descarregar o ficheiro OpenAPI

Esta página é uma maquete de design. Cada endpoint e payload apresentado foi retirado de docs.anivahealth.com, e o diagrama do pipeline é ilustrativo.

As cópias da documentação legíveis por máquina estão em docs.anivahealth.com/llms.txt e docs.anivahealth.com/llms-full.txt.