OAuth2-Authentifizierung

Support DQE
Support DQE
  • Aktualisiert

Verwenden Sie OAuth2, um vor dem Aufruf der DQE-APIs ein temporäres Bearer-Token zu generieren. Der Ablauf verwendet Ihren Lizenzcode, Ihr Client Secret und den angeforderten Scope, um ein Zugriffstoken mit begrenzter Gültigkeitsdauer zurückzugeben.

GET-Anfrage

Verwenden Sie diesen Endpunkt, um mit der Methode GET ein OAuth2-Zugriffstoken zu generieren.

Endpunkt

https://{SERVER_ADDRESS}/oauth/access_token/?client_secret={CLIENT_SECRET}&scope={SCOPE}&client_id={LICENCE_CODE}

Ersetzen Sie die Werte in geschweiften Klammern durch Ihre eigenen Informationen:

Parameter Wert Beschreibung Pflicht/Optional
SERVER_ADDRESS {SERVER_ADDRESS} Adresse des DQE-Servers, der die Daten verarbeitet. Pflicht
client_id {LICENCE_CODE} Ihnen als Lizenzcode zugewiesene Nummer. Pflicht
client_secret {CLIENT_SECRET} Von DQE Software bereitgestellte Passphrase. Pflicht
scope {SCOPE}

Definiert den angeforderten Autorisierungs-Scope. Verfügbare Werte umfassen:

  • client_address — DQE Address APIs
  • client_phone — DQE Phone APIs
  • client_email — DQE Email APIs
  • client_idcheck — DQE ID Check APIs
  • client_general — mehrere DQE-APIs
  • client_b2b — DQE B2B APIs
  • client_civility — DQE Name APIs
 Pflicht

POST-Anfrage

Verwenden Sie diesen Endpunkt, um mit der Methode POST ein OAuth2-Zugriffstoken zu generieren.

Endpunkt

https://{SERVER_ADDRESS}/oauth/access_token/

Methode: POST

Fügen Sie die folgenden Parameter im Anfragetext mittels x-www-form-urlencoded hinzu.

Parameter Wert Beschreibung Pflicht/Optional
client_id {LICENCE_CODE} Ihnen als Lizenzcode zugewiesene Nummer. Pflicht
client_secret {CLIENT_SECRET} Von DQE Software bereitgestellte Passphrase. Pflicht
scope {SCOPE}

Definiert den angeforderten Autorisierungs-Scope. Verfügbare Werte umfassen:

  • client_address — DQE Address APIs
  • client_phone — DQE Phone APIs
  • client_email — DQE Email APIs
  • client_idcheck — DQE ID Check APIs
  • client_general — mehrere DQE-APIs
  • client_b2b — DQE B2B APIs
  • client_civility — DQE Name APIs
 Pflicht

Antwort

Erfolgsantwort

Wenn die Authentifizierung erfolgreich ist, gibt die API ein JSON-Dictionary mit den folgenden Schlüsseln zurück:

Schlüssel Beschreibung Typ
access_token Temporäres Token zum Aufrufen des Dienstes. STRING
token_type Bearer — autorisierter Tokentyp. STRING
expires_in Gültigkeitsdauer des Tokens, in Sekunden. STRING
refresh_token Token zur Verlängerung Ihrer Sitzung. STRING

Beispiel:

{
  "access_token": "TK948869a6f873adb622enhoaGeVY2iRaptqlmpplGeWZA",
  "token_type": "Bearer",
  "expires_in": "300",
  "refresh_token": "*TK9bdd05f8e9d3c905834bdeqaUlGFll2iRaplll29mZmtkZQ"
}

Fehlerantworten

Fehlertyp Beispielanfrage Antworttyp
Fehlender Parameter client_id https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&scope=client_address 400-Fehler (Invalid Request)
Leerer Parameter client_id https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&scope=client_address&client_id= 400-Fehler (Invalid Request)
Falscher client_id (abgelaufen, außerhalb des Scopes oder nicht vorhanden) https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&scope=client_address&client_id={INCORRECT_LICENCE_CODE} 400-Fehler (Invalid Client)
client_id autorisiert den angeforderten scope nicht https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&scope=client_address&client_id={LICENCE_CODE_NOT_AUTHORIZED} 400-Fehler (Unauthorized Client)
Unbekannter Wert für den Parameter scope https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&scope=client&client_id={LICENCE_CODE} 400-Fehler (Unsupported Grant Type)
Fehlender oder leerer Parameter client_secret https://{SERVER_ADDRESS}/oauth/access_token/?scope=client_address&client_id={LICENCE_CODE}
https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=&scope=client_address&client_id={LICENCE_CODE} 		400-Fehler (Invalid Request)
Fehlender oder leerer Parameter scope https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&client_id={LICENCE_CODE}
https://{SERVER_ADDRESS}/oauth/access_token/?client_secret=abcd&scope=&client_id={LICENCE_CODE} 		400-Fehler (Invalid Request)
Tippfehler im Parameter https://{SERVER_ADDRESS}/oauth/access_token/?client_scret=abcd&scope=client_address&client_id={LICENCE_CODE} 500-Fehler

Swagger-Dokumentation

Verknüpfung mit

War dieser Beitrag hilfreich?

0 von 0 fanden dies hilfreich