Prozessänderung für API-Integrationen - Januar 2022

von

Es gibt eine Änderung an dem Prozess für die initiale Verknüpfung von Drittanbieter-Apps mit ready2order Konten.

Wer ist von den Änderungen betroffen?

  1. Falls Du derzeit eine Integration einer Drittanbieter-App entwickelst, hat sich der Authentifizierungsprozess geändert.
  2. Falls Du eine bestehende Integration hast, die regelmäßig den Zugriff widerruft, muss die Integration auf den neuen Prozess aktualisiert werden.

Was ist dieses Dokument?

Dieses Dokument führt Dich durch die notwendigen Änderungen, die in Drittanbieter-Apps vorgenommen werden müssen, um sicherzustellen, dass der anfängliche Authentifizierungsprozess für ready2order Konten weiterhin funktioniert.

Um mit ready2order's API zu arbeiten, ist es notwendig, einen API-Token für ein bestimmtes ready2order Konto anzufordern. Um diesen API-Token zu erhalten, muss der ready2order-Kunde auf eine bestimmte Seite umgeleitet werden, auf der sich der ready2order-Kunde einloggen muss. Nach erfolgreichem Login muss der ready2order-Kunde zustimmen, dass die Drittanbieter-App auf die Kontodaten zugreifen kann.

Welcher Teil ist von dieser Änderung betroffen?

Der Prozess, mit dem Du den anfänglichen API-Developer-Token erhältst, hat sich geändert.

Wenn Du einen Grund hast, den API-Developer-Token zu widerrufen, wird der Prozess, mit dem Du einen neues erhältst, wie unten beschrieben geändert.

Was wird sich ändern?

Alter Prozess

Ein Drittentwickler hat den ready2order-Kunden auf diese Seite umgeleitet.

Dieser Prozess ist veraltet und wird bis zum 28. Februar 2022 außer Betrieb genommen.

Neuer Prozess

  1. Verwende Deinen Developer-Token (der Dir bei der Registrierung als API-Entwickler per E-Mail zugesandt wurde), um einen temporäres Grant-Access-Token anzufordern 
Wenn Du die Original-E-Mail verloren hast und den Token nicht in der Konfiguration Deiner Drittanbieter-App gespeichert hast, wende Dich bitte an den ready2order-Support.

POST https://api.ready2order.com/v1/developerToken/grantAccessToken

Authorization: {DEVELOPER_TOKEN}

Accept: application/json

{

  "authorizationCallbackUri" : null|string

}

 

Optional kann der Parameter authorizationCallbackUri im Request-Body angegeben werden, der eine gültige, öffentlich zugängliche URL enthalten muss, an die wir den ready2order-Kunden nach der Genehmigung oder Ablehnung weiterleiten werden. Falls sie angegeben wird, leiten wir den ready2order-Kunden zu dieser Seite mit den folgenden Parametern um.

GET https://example.com/redirect-endpoint?status=approved|abgelehnt&accountToken=${ACCOUNT_TOKEN}&grantAccessToken=${GRANT_ACCESS_TOKEN}

 

Bitte beachte, den an die authorizationCallbackUri übergebenen grantAccessToken mit dem Grant-Access-Token auf Deiner Seite zu vergleichen, um unerwartete Ergebnisse zu vermeiden.

 

  1. Verwendung des grantAccessUri und Weiterleitung des ready2order-Kunden auf diese Seite.

Als Nächstes wird der ready2order-Kunde aufgefordert, sich einzuloggen und kann entweder den Zugang für Deine App gewähren oder ablehnen.

Wenn der ready2order-Kunde zugestimmt hat und keine authorizationCallbackUri angegeben wurde, wird dem ready2order-Kunden nur der Account-Token für die Nutzung der API angezeigt.

Wenn der ready2order-Kunde zugestimmt hat und eine authorizationCallbackUri angegeben wurde, wird der ready2order-Kunde an die angegebene Adresse weitergeleitet und der Account-Token für die Nutzung der API kann aus dem Query-Parameter accountToken gelesen werden.

Weitere Informationen findest Du in der API-Dokumentation.
Wenn der Account-Token aus irgendeinem Grund ungültig wird, muss der Prozess erneut durchgeführt werden, um einen aktiven Account-Token zu erhalten.