Zum Hauptinhalt springen

API Endpoint

Nachdem das iframe eine analysis_completed-Nachricht sendet, verwendet Ihr Backend den Berichts-Identifier, um den vollständigen DiagnosticReport aus der API abzurufen.

Endpunkt​

GET https://api.example.com/s2s/v3/anonymous-diagnostic-reports/{encryptedId}
    ?format=pdf|raw
    &locale={locale}
  • {encryptedId} (Pfad): der id-Wert, der im analysis_completed-Ereignis empfangen wurde. URL-kodieren Sie ihn.
  • format (Abfrage):
    • v3 API: raw (JSON, Standard), fhir (FHIR-konformes JSON) oder pdf (PDF-Binär).
    • v2 API: nur pdf (funktioniert ohne format-Parameter).
  • locale (Abfrage): Berichtssprache. Akzeptiert Werte wie en, es, pt und andere, je nach Systemunterstützung.

Authentifizierung​

Senden Sie Ihren S2S-API-Token im X-API-TOKEN-Header. Der S2S-Token darf Ihr Backend niemals verlassen.

Beispiel 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"

Referenz​

Der vollständige Endpunkt-Vertrag wird in der getAnonymousDiagnosticReport-Operation der S2S v3 API-Spezifikation veröffentlicht.

Für das Schema des Berichts selbst, siehe JSON Formats-Abschnitt.

Nächste Schritte​

  • Ausgabeformat wählen? Siehe Formats-Abschnitt.
  • JSON-Antwort analysieren? Siehe JSON Standard-Seite.
  • Live-Bericht in Ihrer UI einbetten? Siehe User Interface-Seite.