Aller au contenu principal

Point de terminaison API

Une fois que l'iframe affiche un message analysis_completed, votre backend utilise l'identifiant du rapport pour récupérer le DiagnosticReport complet depuis l'API.

Point de terminaison

GET https://api.example.com/s2s/v3/anonymous-diagnostic-reports/{encryptedId}
?format=pdf|raw
&locale={locale}
  • {encryptedId} (chemin): la valeur id reçue dans l'événement analysis_completed. Codifiez-la dans l'URL.
  • format (requête):
    • API v3: raw (JSON, par défaut), fhir (JSON conforme FHIR), ou pdf (binaire PDF).
    • API v2: pdf uniquement (fonctionne sans paramètre format).
  • locale (requête): langue du rapport. Accepte des valeurs telles que en, es, pt, et d'autres selon le support du système.

Authentification

Envoyez votre jeton API S2S dans l'en-tête X-API-TOKEN. Le jeton S2S ne doit jamais quitter votre backend.

Exemple cURL

curl -X GET "https://api.example.com/s2s/v3/anonymous-diagnostic-reports/{encryptedId}\
?format=raw\
&locale=es" \
-H "X-API-TOKEN: YOUR_S2S_TOKEN" \
-H "accept: application/json"

Référence

Le contrat complet du point de terminaison est publié dans l'opération getAnonymousDiagnosticReport de la spécification API S2S v3.

Pour le schéma du rapport lui-même, consultez la section JSON Formats.

Prochaines étapes

  • Choisir un format de résultat? Consultez la section Formats.
  • Analyser la réponse JSON programmatiquement? Consultez la page JSON Standard.
  • Intégrer un rapport en direct dans votre interface? Consultez la page User Interface.