Catalogue de tests
Récupérer un biomarqueur
Récupérer un seul biomarqueur par 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]
}
]
}
}
Renvoie un seul biomarqueur à partir de son
id numérique. Utile pour obtenir tous les détails (nom, unité, échantillon, catégorie) à partir des identifiants renvoyés par Lister les panels ou par les payloads de rendez-vous, sans parcourir tout le catalogue.
Il s’appuie sur le même catalogue que Lister les biomarqueurs, envoie donc la même origine. Un biomarqueur archivé renvoie 404. Même chose pour un biomarqueur que tu ne peux pas commander à cette origine avec les laboratoires accessibles à ta clé.
Nécessite le scope panels_access. L’objet pricing nécessite aussi le scope prices_view.
Paramètres de chemin
Paramètres de requête
L’origine prend l’une de ces deux formes : un lieu de prélèvement ou un kit à domicile. Envoie-en exactement une. Aucune ou les deux renvoient400.
- Lieu de prélèvement
- Kit à domicile
Remplace la grille tarifaire utilisée par
price_cents : retail, ou l’id d’une grille tarifaire accessible à ta clé. Obtenir une grille tarifaire renvoie cet id. Par défaut, la grille du compte de facturation de ta clé API, sinon le tarif public.Réponse
Unité de mesure par défaut. Utilise
id pour faire le lien avec Lister les unités si
tu as besoin d’un identifiant stable malgré les renommages.Ce que coûte ce biomarqueur et comment il est vendu — voir les objets de
prix.
null uniquement lorsque ta clé n’a pas
le scope prices_view ; un biomarqueur sans prix défini par Aniva est quand même renvoyé, avec
pricing.price_cents: null.Réponses d’erreur
| Statut | Description |
|---|---|
400 | Erreur de validation — id invalide, aucune origine ou deux origines, ou rate_card inconnu/non autorisé. |
403 | Interdit — scope panels_access manquant. |
404 | Biomarqueur introuvable, archivé ou non commandable à cette origine. Aussi pour un location_id inconnu. |
500 | Erreur interne du serveur. |
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]
}
]
}
}