# Endpunkte Übersicht

Jeder Endpunkt muss über https aufgerufen werden. Bezüglich des state-Parameters:

  • Es wird empfohlen, aufgrund von GET-Beschränkungen in Browsern und POST-Beschränkungen, die aus Sicherheitsgründen auf dem Server eingerichtet werden können, übermäßig lange Werte zu vermeiden. Alles bis zu 255 Zeichen ist in Ordnung.
  • Es wird dringend empfohlen, nur Zeichen aufzunehmen, die aufgrund unterschiedlicher Kodierungen/Zeichensätze zwischen Client und Server nicht verstümmelt werden können oder von Sicherheitsmaßnahmen wie dem XSS-Schutz betroffen sind.
    Als Faustregel gilt, dass Sie nur a-z, A-Z, 0-9 und die Sonderzeichen -+,.=_ verwenden sollten;
  • Für eine sichere Kommunikation wird TLS 1.2 & TLS 1.3 (empfohlen) unterstützt.
Endpunkt Beschreibung
Authorization Endpunkt Starten Sie den OAuth Authorization-Code-Flow. Leiten Sie den Benutzer an diesen Endpunkt weiter, um sich bei DocCheck zu authentifizieren. Bei erfolgreichem Login erhalten Sie einen Autorisierungscode (code). Stellen Sie sicher, dass client_id, redirect_uri und scope korrekt gesetzt und redirect_uri URL-encoded sind.
Access Token Endpunkt Rufen Sie einen Access Token mit dem Autorisierungscode - code - ab, der vom Login-Endpunkt übergeben wurde.
Der Access Token ist 1 Stunde lang gültig. Der Refresh Token ist 180 Tage lang gültig.
Userdaten Endpunkt Abruf von Benutzerdaten mit Access Token.
Die Daten sind HTML-kodiert (Köln für "Köln"). Für JSON-Kodierung fügen Sie den Parameter dc_oauth_format=json an die Anfrage an. Rückgabewerte: Übersicht.
Refresh Token Endpunkt Holt einen neuen Access Token vom Refresh Token.