API Dosimétrie RIV
Pour envoyer une requête à l'API et lire la réponse.
Endpoints
GET /api/config: radiopharmaceutiques, options de cures, champs de saisie (fields), saisie attendue pour chaque isotope (isotope_inputs) et scénarios d'exposition.POST /api/calculate: calcule les durées de restriction.GET /health: disponibilité du service.
Payload — POST /api/calculate
{
"isotope_code": "iode131_25_fixation",
"dose_rate": 9.9,
"patient_size_cm": 150,
"user_period_days": null,
"user_hours_1": null,
"user_distance_1": null,
"user_hours_2": null,
"user_limit": null,
"benign_activity_mbq": null,
"benign_fixation_pct": null,
"cure_count": 1,
"provider": "nom-de-votre-logiciel"
}
Règles
- provider (facultatif) : nom et version du logiciel qui appelle l'API (ex.
MonRIS 2.1), 64 caractères maximum (lettres, chiffres, espace et. _ : / @ + ( ) -). Simple déclaration, non vérifiée : c'est la clé d'API qui identifie le fournisseur (les requêtes du site sont enregistrées au nom du site). - Standard :
dose_rate+patient_size_cm. - iode131_benin :
benign_activity_mbq+benign_fixation_pct(%) ;dose_rateignoré. - non_defini :
user_period_daysstrictement positif obligatoire. - cure_count :
psma_177lu(1/4/6),lutetium177_net(1/4), sinon 1 uniquement. - cure_count > 1 : limite répartie sur les cures, sauf
transport_commun(non cumulé).
Réponse (succès)
{
"ok": true,
"selected": { "api_code": "...", "label": "..." },
"cure_count": 1,
"computed_dose_rate": 9.9,
"effective_days": 0.67,
"effective_hours": 16,
"errors": [],
"recommendations_days": {
"conjoint_plus_60": 0,
"conjoint_moins_60": 0,
"conjointe_enceinte": 0,
"transport_commun": 0,
"enfant_moins_3_ans": 0,
"enfant_3_11_ans": 0,
"collegues_travail": 0,
"scenario_utilisateur": null
},
"rows": [
{ "audience_code": "conjoint_plus_60", "label": "...", "condition": "...", "value": 0 }
]
}
rows reprend les valeurs de recommendations_days avec un libellé et un texte de condition prêts à afficher pour chaque scénario.
Recommandation d'intégration : identifiez toujours un scénario par son audience_code (ou par sa clé dans recommendations_days), jamais par le texte de label ou de condition. Ces textes sont faits pour l'affichage, peuvent être reformulés d'une version à l'autre du site sans changer le sens ni les valeurs, et ne doivent pas servir de clé de recherche. Les codes (conjoint_plus_60, transport_commun...) et les noms des champs de la réponse sont, eux, stables.
Réponse (erreur de validation)
{
"ok": false,
"error": { "code": "VALIDATION_ERROR", "message": "...", "reason": "..." },
"errors": ["..."]
}
Isotopes disponibles (isotope_code)
| Libellé | Code API |
|---|---|
| Iobenguane (MIBG) · iode 131 | mibg_131i |
| Iode 131 (0 %) · néoplasie | iode131_0_fixation |
| Iode 131 (5 %) · néoplasie oligométastatique | iode131_5_fixation |
| Iode 131 (25 %) · néoplasie multimétastatique | iode131_25_fixation |
| Iode 131 · indication non néoplasique | iode131_benin |
| Lipiodol marqué à l'iode 131 | lipiodol_131i |
| Lutétium 177 · PSMA | psma_177lu |
| Lutétium 177 · tumeurs neuroendocrines | lutetium177_net |
| Microsphères d'holmium 166 | microspheres_166ho |
| Microsphères d'yttrium 90 | microspheres_90y |
| Radiosynoviorthèse · erbium 169 | synovectomie_169er |
| Radiosynoviorthèse · rhénium 186 | synovectomie_186re |
| Radiosynoviorthèse · yttrium 90 | synovectomie_90y |
| Radium 223 | radium223 |
| Personnalisé | non_defini |
Scénarios d'exposition (audience_code)
Liste lue en direct sur GET /api/config : elle reflète toujours le moteur de calcul actif.
| Libellé | Code API | Hypothèse |
|---|---|---|
| Chargement… | ||
Authentification (clé d'API, si l'administrateur l'exige)
Tout appel extérieur à POST /api/calculate peut devoir présenter une clé d'API propre à votre logiciel ou service,
fournie par l'administrateur du site : elle est obligatoire uniquement si l'administrateur l'exige (réglage du site ; sinon les appels sans clé sont acceptés). Transmettez-la dans l'en-tête HTTP X-API-Key (ou Authorization: Bearer <clé>),
jamais dans l'adresse, en HTTPS uniquement :
POST /api/calculate
Content-Type: application/json
X-API-Key: rdv_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
- Clé absente alors qu'elle est exigée :
401,"code": "API_KEY_REQUIRED". Clé invalide, expirée, révoquée ou fournisseur suspendu :401,"code": "API_KEY_INVALID". - Chaque fournisseur a son propre plafond de requêtes par minute (
429au-delà). - Gardez la clé secrète (jamais dans une page web publique ni un dépôt de code) ; en cas de fuite, demandez-en la révocation et une nouvelle clé.
GET /api/configetGET /healthrestent publics.