Aller au contenu principal

Démarrage rapide

Cette page vous guide à travers le travail minimum requis pour intégrer l'iframe dans votre application, exécuter une analyse et récupérer le DiagnosticReport résultant. Tout ce qui est décrit ici peut être personnalisé davantage ; consultez la page Configurer, Personnaliser pour la référence des paramètres complets.

1. Obtenir un identifiant d'entreprise​

L'iframe s'authentifie au moyen d'un identifiant d'entreprise (aussi appelé clé d'application) qui est ajouté à l'URL de l'iframe en tant que paramètre de requête company.

Vous générez cet identifiant à partir de votre jeton API S2S en appelant le point de terminaison POST /company-app-keys décrit dans la page Sécurité. Chaque clé générée a une expiresAt explicite, afin que vous deviez traiter l'identifiant d'entreprise comme une credential de courte durée et l'actualiser à chaque nouveau chargement d'iframe.

Ne jamais intégrer le jeton API S2S

Le jeton API S2S est le secret utilisé pour générer les identifiants d'entreprise. Il doit rester sur votre backend. Seule la valeur company courte durée résultante (la appKey) est sûre à mettre dans l'URL de l'iframe.

2. Construire l'URL de l'iframe​

L'iframe est servie depuis https://iframe.legit.health. Ajoutez les paramètres dont vous avez besoin ; seul company est obligatoire:

<iframe
  src="https://iframe.legit.health/?company=YOUR_COMPANY_ID"
  width="100%"
  height="800"
></iframe>

Utilisez le générateur ci-dessous pour prévisualiser une configuration et copier l'URL résultante. Pour la référence des paramètres complets, consultez la page Configurer, Personnaliser.

#
#
Remplacer l'identifiant par défaut

Le générateur utilise un identifiant company exemple afin que la prévisualisation fonctionne. Remplacez-le avec votre propre identifiant avant de déployer.

3. Écouter le résultat​

Lorsque l'utilisateur termine l'upload, l'iframe affiche un message annonçant que l'analyse est complète et inclut l'identifiant du rapport résultant:

window.addEventListener("message", function (event) {
  if (event.data.message !== "analysis_completed") {
    return;
  }
  const reportId = event.data.id;
  // stocker reportId, récupérer le rapport depuis votre backend, etc.
});

Le même message est livré via différents transports sur iOS et Android. Consultez la page Callbacks, Analysis completed pour le code par plateforme, et la section Platforms pour les détails d'intégration sur chaque runtime.

4. Récupérer le rapport​

Une fois que vous avez un identifiant de rapport, votre backend récupère le DiagnosticReport complet depuis l'API:

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

La réponse inclut une URL de téléchargement PDF et une URL de rapport en direct que vous pouvez intégrer dans votre interface. Consultez la page Output, API Endpoint pour les paramètres et la forme de la réponse, et la section Output, JSON Schema pour le schéma de charge utile complet.

Séquence end-to-end​

Le diagramme ci-dessous montre le cycle de vie complet d'une seule analyse. Les étapes 1, 3, 5 et 6 sont les seules qui nécessitent un effort d'intégration de votre côté: charger l'iframe, stocker le reportId du postMessage, et appeler l'API Legit.Health depuis votre backend pour récupérer le DiagnosticReport. Chaque autre étape est gérée par l'iframe, l'utilisateur, ou l'API Legit.Health.

Prochaines étapes​

  • Personnaliser l'iframe? Consultez la page Configurer, Personnaliser.
  • Sécuriser l'accès en production? Consultez la page Configurer, Sécurité.
  • Comprendre la structure du callback? Consultez la section Callbacks.
  • Afficher ou traiter les résultats? Consultez la section Output.