• Zuletzt bearbeitet am: 19 August 2022

OAuth 2.0 Übergangsleitfaden

Einleitung

In diesem Artikel werden die Schritte erläutert, die Sie ausführen müssen, um OAuth-Clients in Coupa zu konfigurieren, damit Sie von API-Schlüsseln zu OAuth 2.0 wechseln können.

Hinweis

API-Schlüssel-Sonnenuntergang und -Übergang wirken sich nur auf vom Kunden erstellte API-Integrationen in die Coupa-Kernplattform aus und wirken sich nicht auf Anwendungen wie Treasury, CSO, Supply Chain Design & Planning usw. aus.

Von Coupa erstellte API-Schlüssel sollten nicht widerrufen werden. Diese Schlüssel werden separat übertragen, ohne dass Sie etwas tun müssen.

So funktioniert es

Hinweis

 Bitte führen Sie die folgenden Schritte für alle Ihre Coupa-Instanzen aus (Produktion, Test, Entwicklung, Bühne usw.).

1. API-Schlüssel in Coupa prüfen

  1. Melden Sie sich bei Ihrer Coupa-Instanz an.
  2. Wählen Sie „Konfiguration“ > „API-Schlüssel“.
  3. Alle Schlüssel prüfen.

2. OAuth Client Erstellung und Scope Zuordnung

  1. Wählen Sie „Konfiguration“ > „Oauth2/OpenID Connect-Clients“ (/oauth2/clients).
  2. Klicken Sie auf Erstellen und wählen Sie im Dropdown-Menü Gewährungstyp die Option Client-Anmeldedaten aus.
  3. Füllen Sie die Felder aus und wählen Sie die Bereiche (Zugriffsberechtigungen) aus, die der Kunde benötigt. Beachten Sie, dass Sie, wenn Sie einem Client Zugriff auf alle API-Endpunkte und -Operationen gewähren möchten, alle Bereiche zu diesem Client hinzufügen müssen. 
    Kundenbildschirm erstellen.
  4. Sobald Sie den Client gespeichert haben, erhalten Sie die Client-Anmeldeinformationen: IdentifierSecretOidc Scopes.
    OATH-Kundeninformationen wurden nach dem Speichern zurückgegeben.

3. Anmeldedaten-Test (Konnektivitätstest mit einem HTTP-Client wie Postman)

  1. Verwenden Sie das Terminal (LINK), 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
    Curl-Pfosten (Beispiel).
  2. Konfigurieren Sie mit einem HTTP-Client wie Postman oder einem ANDEREN REST-Client eine OAuth2/OIDC-Clientverbindung zur Verwendung der Coupa-API.
  3. Wählen Sie POST.
  4. Legen Sie die URL auf den Instanznamen fest, unter dem Sie den Client oben definiert haben. Beispiel: https://{your_instance_address}/oauth2/token
  5. Legen Sie den Header-Schlüsselwert für Content-Type = application/x-www-form-urlencoded fest
    INHALTSTYP Beitragsbeispiel.
  6. STELLEN Sie im Post-Body die folgenden Werte ein:
    1. client_id = <Your Client Identifier value>
    2. grant_type = client_credentials
    3. scope = <Copy/paste all the scopes that you selected in Client credentials setup without the comma.>
    4. client_secret = < Coupa Client Secret-Wert kopieren/einfügen >
      POST-KÖRPEREINSTELL
  7. Klicken Sie auf Senden. Die POST-ANTWORT verfügt über das access_token, das generiert wurde, um API-Aufrufe innerhalb des definierten Bereichs für die nächsten 24 Stunden zu autorisieren (expires_in 86.399 Sekunden). 
    Beispiel für eine BEITRAGSANTWORT.

  8. Kopieren Sie den Wert access_token aus dem Antworttext und verwenden Sie ihn als Token-Wert in den Autorisierungs-Headern für Ihre Coupa-API-Aufrufe innerhalb des Bereichs, den Sie für diese Client-Verbindung definiert haben. 

  9. Erstellen Sie einen neuen Tab, um API-Aufrufe zum ABRUFEN, POSTEN oder SETZEN usw. durchzuführen, und definieren Sie im Autorisierungsteil des Request Builders den ‘TYPE’ = OAuth 2.0.

  10. Fügen Sie das access_token als Token-Feldwert ein.
    Beispiel für einen Token-Feldwert.

  11. Gehen Sie zu Headers und geben Sie einen Wert von application/xml oder application/json in das Feld Accept key ein. Sie müssen die anderen Anforderungsparameter entsprechend dem Aufruf und der Schnittstelle, die Sie verwenden möchten, einstellen und definieren. Im Beispiel sehen Sie einen GET-API-Aufruf an die Invoices-API.
    Beispiel für ein Schlüsselfeld übernehmen.

  12. Klicken Sie auf Senden. Mit diesem access_token, das im Authorization-Header festgelegt ist, können Sie GET, PUT oder Post-Anrufe AN die Client-Bereiche tätigen, die Sie für diese Verbindung definiert haben.
    Beispiel für eine erfolgreiche Anfrage.

4. Middleware-Skript/-Fluss zur Token-Erstellung erstellen und alle 20 Stunden aktualisieren

Je nach Middleware können 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/Flow erstellt werden, um sicherzustellen, dass dieses alle 20 Stunden aktualisiert wird. Die meisten Adapter in den Middlewares aktualisieren den Token automatisch, sobald die Einrichtung abgeschlossen ist.

Warnung

Das Ändern der Bereiche in einem Client wirkt sich auf das Token-Generierungsskript/-adapter aus, da diese in der Token-Generierungsanforderung übergeben werden.

Flussbeispiel.

Informationen zum Einrichten des OAuth2.0-Adapters finden Sie unter den folgenden Dokumentationslinks:

5. Integrationen aktualisieren, um neues Token zu verwenden, das vom Skript generiert wurde

Alle vorhandenen Integrationen müssen die OAuth-Verbindung übernehmen und das vom neuen Skript/Flow generierte Token verwenden. Dies kann beispielsweise in Phasen geschehen, in denen Stammdatenintegrationen zuerst übertragen werden, gefolgt von transaktionalen Datenintegrationen zu einem späteren Zeitpunkt.

6. Alte API-Schlüssel deaktivieren

Im Rahmen des Transitionsprozesses deaktivieren Sie bitte vorhandene API-Schlüssel, damit diese nach der Transition auf OAuth2.0 nicht mehr verwendet werden.

  1. Wählen Sie „Konfiguration“ > „API-Schlüssel“.
  2. Alten API-Schlüssel bearbeiten.
  3. Klicken Sie auf API-Schlüssel widerrufen.

7. Verfügbare Ressourcen und Informationen im Coupa Success Portal

Coupa-Webinare

Sie können auch die folgenden Ressourcen verwenden, um mehr zu erfahren:

Vergleichbare Artikel


Optionen für die Abfrage

21 October 2016

Erfahren Sie, wie Sie Abfragen verwenden können, um die benötigten Daten schnell zu identifizieren und abzurufen.

Spezielle Aktionen und API-Notizen

21 October 2016

Weitere Informationen zur Verwendung der Coupa-API.

Unterschiede zwischen XML und json in Coupa

16 December 2016

Integrationsausführungen-API

24 April 2017

Verwenden Sie diese API, um einen Integrationslauf zu erstellen, abzufragen oder zu aktualisieren sowie den Status zu aktualisieren.

Hinweis: Einige Inhalte wurden maschinell übersetzt.