OAuth 2.0 Übergangshandbuch
Einleitung
Dieser Artikel beschreibt die Schritte, die Sie ausführen müssen, um OAuth-Clients in Coupa zu konfigurieren, um von API-Schlüsseln zu OAuth 2.0 zu wechseln.
API-Schlüssel-Sunsetting und -Übergang wirken sich nur auf Kundenintegrationen in die Coupa-Kernplattform aus undhaben keine Auswirkungen auf Anwendungen wie Treasury, CSO, Supply Chain Design & Planning usw.
So funktioniert es
Führen Sie die folgenden Schritte für alle Ihre Coupa-Instanzen aus (Produktion, Test, Entwicklung, Phase usw.).
1. Überprüfen Sie die API-Schlüssel in Coupa
- Melden Sie sich bei Ihrer Coupa-Instanz an.
- Navigieren Sie zu Konfiguration > API-Schlüssel.
- Überprüfen Sie alle Schlüssel.
2. OAuth Client-Erstellung und Bereichszuweisung
- Navigieren Sie zu Konfiguration > Oauth2/OpenID Connect-Clients (/oauth2/clients).
- Klicken Sie auf Erstellenund wählen Sie Client-Anmeldeinformationenin derDropdown-ListeErteilungstyp.
- Füllen Sie die Felder aus und wählen Sie die Bereiche (Zugriffsberechtigungen) aus, die der Kunde benötigt. Beachten Sie, dass Sie diesem Client alle Bereiche hinzufügen müssen, wenn Sie einem Client Zugriff auf alle API-Endpunkte und -Vorgänge gewähren möchten.
- Sobald Sie den Kunden gespeichert haben, erhalten Sie die Client-Anmeldeinformationen: Identifier,Secret, OIDCScopes.
3. Anmeldeinformationstest (Verbindungstest mit einem HTTP-Client wie Postman)
- Verwenden Sie mit Terminal (LINK) die Befehlszeile, um einen Curl-POST auszuführen:
curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "client_id=<CLIENT_ID>&grant_type=client_credentials&scope=<SPACE_SEPARATED_LIST_OF_SCOPES>&client_secret=<CLIENT_SECRET>" https://<INSTANCE_DOMAIN>/oauth2/token
- Konfigurieren Sie mit einem HTTP-Client wie Postman oder einem anderen REST-Client eine OAuth2/OIDC-Client-Verbindung, um die Coupa-API zu verwenden.
- Wählen Sie POSTaus.
- Legen Sie die URL auf den Instanznamen fest, unter dem Sie den Kunden oben definiert haben. Beispiel: https://{your_instance_address}/oauth2/token
- Legen Sie den Header-Schlüsselwert für Content-Type = fest
application/x-www-form-urlencoded
- Legen Sie im POST-Text die folgenden Werte fest:
-
Klicken Sie auf "Senden". The POST response has the
access_token
that was generated to authorize API calls within the defined scope for the next 24 hours (expires_in
86.399 seconds).
-
Kopieren Sie Ihren
access_token
Wert aus dem Antworttext und verwenden Sie ihn als Tokenwert in Autorisierungskopfzeilen für Ihre Coupa-API-Aufrufe in dem Bereich, den Sie für diese Clientverbindung definiert haben. -
Erstellen Sie eine neue Registerkarte, um API-Aufrufe für GET, POST oder PUT usw. vorzunehmen, und definieren Sie imAutorisierungs- Teil des Anforderungs-Generators "TYPE" =
OAuth 2.0
. -
Gehen Sie zu Kopfzeilen und geben Sie einen Wert von
application/xml
oderapplication/json
in das Schlüsselfeld Akzeptieren ein. Sie müssen die anderen Anforderungsparameter entsprechend dem Aufruf und der Schnittstelle, die Sie verwenden möchten, festlegen und definieren. Im Beispiel sehen Sie einen GET-API-Aufruf für die Rechnungs-API.
-
Klicken Sie auf "Senden". Mit dieser Einstellung
access_token
in der Autorisierungskopfzeile können Sie GET-, PUT- oder POST-Aufrufe an die Client-Bereiche vornehmen, die Sie für diese Verbindung definiert haben.
4. Erstellen Sie Middleware-Skripts/Abläufe für die Tokenerstellung und aktualisieren Sie sie alle 20 Stunden
Je nach Middleware können die Konfigurationen variieren. Es ist jedoch wichtig, sicherzustellen, dass alle Integrationen, die Coupa-API-Schlüssel verwenden, aktualisiert werden, um das OAuth-Token zu verwenden. Für die Generierung und Aktualisierung dieses Tokens muss möglicherweise ein neues Skript/ein neuer Ablauf erstellt werden, um sicherzustellen, dass dies alle 20 Stunden aktualisiert wird. Die meisten Adapter in der Middleware aktualisieren das Token automatisch, sobald die Konfiguration abgeschlossen ist.
Das Ändern der Bereiche in einem Client wirkt sich auf das Token-Generierungsskript/-adapter aus, da diese in der Token-Generierungsanforderung übergeben werden.
Unter den folgenden Dokumentations-Links finden Sie verschiedene Middleware-Informationen zum Einrichten des OAuth2.0-Adapters:
- SNAPLOGIC-Dokumentation
- MULESOFT-Dokumentation
- BOOMI-Dokumentation
- SAP PO-Dokumentation
- WEBMETHODS-Dokumentation
- INFORMATICA-Dokumentation
5. Integrationen aktualisieren, um neue, von Skript generierte Token zu verwenden
Alle bestehenden Integrationen müssen die OAuth-Verbindung übernehmen und das Token verwenden, das vom neuen Skript/Fluss generiert wird. Dies kann beispielsweise in Phasen erfolgen, in denen Stammdatenintegrationen zuerst übergehen, gefolgt von Transaktionsdatenintegrationen zu einem späteren Zeitpunkt.
6. Alte API-Schlüssel deaktivieren
Deaktivieren Sie im Rahmen des Übergangsprozesses vorhandene API-Schlüssel, damit sie nach dem Übergang zu OAuth2.0 nicht mehr verwendet werden.
- Gehen Sie zu Konfiguration > API-Schlüssel.
- Alten API-Schlüssel bearbeiten.
- Klicken Sie auf API-Schlüsselwiderrufen.
7. Verfügbare Ressourcen und Informationen im Coupa Success Portal
Coupa Webinars
- 25. März 2022: Übergangzu OAuth(API)
Sie können auch die folgenden Ressourcen verwenden, um mehr zu erfahren:
Parts or all of this page might have been machine-translated. We apologize for any inaccuracies.