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
45 endpoints estão documentados e ativos hoje
A autenticação precisa apenas de um cabeçalho de pedido
Cada caminho começa com o prefixo v1
Os locais na Alemanha podem fazer a colheita de sangue
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.