Catálogo de testes
Obter biomarcador
Obter um único biomarcador por ID
GET
/
api
/
v1
/
biomarkers
/
{id}
curl --url 'https://anivahealth.com/api/v1/biomarkers/42?home_kit=true' \
--header 'x-api-key: YOUR_API_KEY'
{
"id": 42,
"slug": "vitamin-d-25-oh",
"name": "Vitamin D (25-OH)",
"description": "Serum 25-hydroxyvitamin D …",
"primary_category": "Vitamins",
"secondary_category": null,
"type": "clinical",
"material": "serum",
"unit": { "id": 1, "title": "nmol/L", "display_title": null },
"pricing": {
"price_cents": 3952,
"retail_cents": 4549,
"tier": "specialty"
}
}
{
"id": 77,
"slug": "mean-platelet-volume",
"name": "Mean Platelet Volume (MPV)",
"description": null,
"primary_category": "Haematology",
"secondary_category": null,
"type": "clinical",
"material": "whole_blood",
"unit": { "id": 7, "title": "fL", "display_title": null },
"pricing": {
"price_cents": 0,
"retail_cents": 0,
"positions": [
{
"id": "3f1a8c22-64bd-4e57-8a90-1c2d3e4f5a6b",
"name": "Blood Count (extended)",
"price_cents": 460,
"retail_cents": 529,
"biomarker_ids": [71, 72, 73, 77],
"includes": [71, 72, 73]
}
]
}
}
Devolve um único biomarcador pelo seu
id numérico. Útil para resolver os IDs devolvidos por Listar painéis ou pelos payloads de marcações em detalhes completos (nome, unidade, material, categoria) sem percorrer todo o catálogo.
Serve o mesmo catálogo que Listar biomarcadores, por isso envia a mesma origem. Um biomarcador arquivado devolve 404. O mesmo acontece com um biomarcador que não podes pedir nessa origem com os laboratórios que a tua chave pode usar.
Requer o scope panels_access. O objeto pricing também requer o scope prices_view.
Parâmetros de caminho
Parâmetros de consulta
A origem tem uma de duas formas: um local de teste ou um kit de teste em casa. Envia exatamente uma. Enviar nenhuma ou ambas devolve400.
- Local de teste
- Kit de teste em casa
Substitui a tabela de preços que
price_cents usa: retail, ou o id de uma tabela de preços que a tua chave pode usar. Obter tabela de preços devolve esse id. Por predefinição, usa a tabela da conta de faturação da tua chave de API; caso contrário, a de venda ao público.Resposta
Unidade de medida predefinida. Usa
id para referenciar em Listar unidades se
precisares de uma identidade estável mesmo após alterações de nome.Quanto custa este biomarcador e como é vendido — consulta objetos de
preço. É
null apenas quando a tua chave não tem o
scope prices_view; um biomarcador sem preço definido pela Aniva continua a ser devolvido, com
pricing.price_cents: null.Respostas de erro
| Estado | Descrição |
|---|---|
400 | Erro de validação — id inválido, sem origem ou com duas origens, ou rate_card desconhecido/não autorizado. |
403 | Proibido — falta o scope panels_access. |
404 | Biomarcador não encontrado, arquivado ou que não pode ser pedido na origem. Também um location_id desconhecido. |
500 | Erro interno do servidor. |
curl --url 'https://anivahealth.com/api/v1/biomarkers/42?home_kit=true' \
--header 'x-api-key: YOUR_API_KEY'
{
"id": 42,
"slug": "vitamin-d-25-oh",
"name": "Vitamin D (25-OH)",
"description": "Serum 25-hydroxyvitamin D …",
"primary_category": "Vitamins",
"secondary_category": null,
"type": "clinical",
"material": "serum",
"unit": { "id": 1, "title": "nmol/L", "display_title": null },
"pricing": {
"price_cents": 3952,
"retail_cents": 4549,
"tier": "specialty"
}
}
{
"id": 77,
"slug": "mean-platelet-volume",
"name": "Mean Platelet Volume (MPV)",
"description": null,
"primary_category": "Haematology",
"secondary_category": null,
"type": "clinical",
"material": "whole_blood",
"unit": { "id": 7, "title": "fL", "display_title": null },
"pricing": {
"price_cents": 0,
"retail_cents": 0,
"positions": [
{
"id": "3f1a8c22-64bd-4e57-8a90-1c2d3e4f5a6b",
"name": "Blood Count (extended)",
"price_cents": 460,
"retail_cents": 529,
"biomarker_ids": [71, 72, 73, 77],
"includes": [71, 72, 73]
}
]
}
}
⌘I
curl --url 'https://anivahealth.com/api/v1/biomarkers/42?home_kit=true' \
--header 'x-api-key: YOUR_API_KEY'
{
"id": 42,
"slug": "vitamin-d-25-oh",
"name": "Vitamin D (25-OH)",
"description": "Serum 25-hydroxyvitamin D …",
"primary_category": "Vitamins",
"secondary_category": null,
"type": "clinical",
"material": "serum",
"unit": { "id": 1, "title": "nmol/L", "display_title": null },
"pricing": {
"price_cents": 3952,
"retail_cents": 4549,
"tier": "specialty"
}
}
{
"id": 77,
"slug": "mean-platelet-volume",
"name": "Mean Platelet Volume (MPV)",
"description": null,
"primary_category": "Haematology",
"secondary_category": null,
"type": "clinical",
"material": "whole_blood",
"unit": { "id": 7, "title": "fL", "display_title": null },
"pricing": {
"price_cents": 0,
"retail_cents": 0,
"positions": [
{
"id": "3f1a8c22-64bd-4e57-8a90-1c2d3e4f5a6b",
"name": "Blood Count (extended)",
"price_cents": 460,
"retail_cents": 529,
"biomarker_ids": [71, 72, 73, 77],
"includes": [71, 72, 73]
}
]
}
}