Zum Hauptinhalt springen

Quickstart

Diese Seite führt Sie durch die Mindestarbeit, die erforderlich ist, um das iframe in Ihre Anwendung einzubetten, eine Analyse auszuführen und das resultierende DiagnosticReport abzurufen. Alles, was hier beschrieben ist, kann weiter angepasst werden; siehe Configure -> Customize-Seite für die vollständige Parameterreferenz.

1. Erhalten Sie einen Unternehmensidentifier​

Das iframe authentifiziert sich mittels eines Unternehmensidentifiers (auch App-Schlüssel genannt), der der iframe-URL als company-Abfrageparameter angefügt wird.

Sie generieren diesen Identifier aus Ihrem S2S-API-Token durch Aufrufen des im Abschnitt Security beschriebenen POST /company-app-keys-Endpunkts. Jeder generierte Schlüssel hat einen expliziten expiresAt, daher sollten Sie den Unternehmensidentifier als kurzlebige Anmeldedaten behandeln und für jedes neue iframe-Laden aktualisieren.

Betten Sie den S2S-API-Token nie ein

Der S2S-API-Token ist der Geheimnis, der zum Prägen von Unternehmensidentifiern verwendet wird. Er muss auf Ihrem Backend bleiben. Nur der resultierende kurzlebige company-Wert (der appKey) ist sicher, um in der iframe-URL platziert zu werden.

2. Erstellen Sie die iframe-URL​

Das iframe wird von https://iframe.legit.health bereitgestellt. Fügen Sie die benötigten Parameter an; nur company ist erforderlich:

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

Verwenden Sie den Generator unten, um eine Konfiguration zu erstellen und die resultierende URL zu kopieren. Für die vollständige Parameterreferenz siehe Configure -> Customize-Seite.

#
#
Ersetzen Sie den Standard-Identifier

Der Generator verwendet einen Beispiel-company-Identifier, sodass die Vorschau funktioniert. Ersetzen Sie ihn mit Ihrem eigenen Identifier, bevor Sie bereitstellen.

3. Warten Sie auf das Ergebnis​

Wenn der Benutzer das Hochladen beendet, sendet das iframe eine Nachricht, dass die Analyse abgeschlossen ist, und enthält den Identifier des resultierten Berichts:

window.addEventListener("message", function (event) {
  if (event.data.message !== "analysis_completed") {
    return;
  }
  const reportId = event.data.id;
  // store reportId, fetch the report from your backend, etc.
});

Die gleiche Nachricht wird unter iOS und Android über verschiedene Transporte bereitgestellt. Siehe Callbacks -> Analysis completed-Seite für den plattformspezifischen Code und den Platforms-Abschnitt für die Einbettungsdetails auf jeder Runtime.

4. Bericht abrufen​

Wenn Sie einen Berichts-Identifier haben, ruft Ihr Backend das vollständige DiagnosticReport aus der API ab:

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"

Die Antwort enthält eine PDF-Download-URL und eine Live-Berichts-URL, die Sie zurück in Ihre Schnittstelle einbetten können. Siehe Output -> API Endpoint-Seite für die Parameter und Antwortform, und den Abschnitt Output -> JSON Schema für das vollständige Payload-Schema.

End-to-End-Sequenz​

Das folgende Diagramm zeigt den vollständigen Lebenszyklus einer einzelnen Analyse. Die Schritte 1, 3, 5 und 6 sind die einzigen, die Integrationsbemühungen auf Ihrer Seite erfordern: Laden des iframes, Speichern der reportId aus postMessage, und Aufrufen der Legit.Health-API von Ihrem Backend aus, um das DiagnosticReport abzurufen. Jeder andere Schritt wird vom iframe, dem Benutzer oder der Legit.Health-API behandelt.

Nächste Schritte​

  • iframe anpassen? Siehe Configure -> Customize-Seite.
  • Produktionszugriff sichern? Siehe Configure -> Security-Seite.
  • Callback-Struktur verstehen? Siehe Callbacks-Abschnitt.
  • Ergebnisse anzeigen oder verarbeiten? Siehe Output-Abschnitt.