• Zuletzt bearbeitet am: 19 August 2022

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.

Hinweis

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

Hinweis

 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

  1. Melden Sie sich bei Ihrer Coupa-Instanz an.
  2. Navigieren Sie zu Konfiguration > API-Schlüssel.
  3. Überprüfen Sie alle Schlüssel.

2. OAuth Client-Erstellung und Bereichszuweisung

  1. Navigieren Sie zu Konfiguration > Oauth2/OpenID Connect-Clients (/oauth2/clients).
  2. Klicken Sie auf Erstellenund wählen Sie Client-Anmeldeinformationenin derDropdown-ListeErteilungstyp.
  3. 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. 
    Bildschirm "Kunden erstellen".
  4. Sobald Sie den Kunden gespeichert haben, erhalten Sie die Client-Anmeldeinformationen: Identifier,Secret, OIDCScopes.
    Eidesstattliche Kundeninformationen nach dem Speichern zurückgegeben.

3. Anmeldeinformationstest (Verbindungstest mit einem HTTP-Client wie Postman)

  1. 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
    Curl POST-Beispiel.
  2. Konfigurieren Sie mit einem HTTP-Client wie Postman oder einem anderen REST-Client eine OAuth2/OIDC-Client-Verbindung, um die Coupa-API zu verwenden.
  3. Wählen Sie POSTaus.
  4. Legen Sie die URL auf den Instanznamen fest, unter dem Sie den Kunden oben definiert haben. Beispiel: https://{your_instance_address}/oauth2/token
  5. Legen Sie den Header-Schlüsselwert für Content-Type = fest application/x-www-form-urlencoded
    POST-Beispiel für Inhaltstyp.
  6. Legen Sie im POST-Text die folgenden Werte fest:
    1. client_id =
    2. grant_type = client_credentials
    3. scope =
    4. client_secret = Coupa-Kundengeheimnis kopieren/einfügen>
      POST-Texteinstellungen.
  7. 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). 
    POST-Antwortbeispiel.

  8. 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. 

  9. 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.

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

  11. Gehen Sie zu Kopfzeilen und geben Sie einen Wert vonapplication/xml oder application/jsonin 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.
    Beispiel für Schlüsselfeld akzeptieren.

  12. 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.
    Erfolgreiches Anforderungsbeispiel

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.

Warnung

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

Ablaufbeispiel.

Unter den folgenden Dokumentations-Links finden Sie verschiedene Middleware-Informationen zum Einrichten des OAuth2.0-Adapters:

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.

  1. Gehen Sie zu Konfiguration > API-Schlüssel.
  2. Alten API-Schlüssel bearbeiten.
  3. Klicken Sie auf API-Schlüsselwiderrufen.

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

Coupa Webinars

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.

Vergleichbare Artikel


Die Coupa Core-API

Unsere RESTful-API bietet robusten Zugriff zum Lesen, Bearbeiten oder Integrieren Ihrer Daten mit der Coupa-Plattform.

Erste Schritte mit der API

Allgemeine Informationen zur Verwendung der Coupa-API und wann Sie CSV verwenden sollten.

Übergang zu OAuth 2.0 und OIDC

Coupa veraltet ältere API-Schlüssel und erfordert die Verwendung von OAuth 2.0 / OIDC. Ab R34 werden keine neuen API-Schlüssel ausgegeben und API-Schlüssel werden mit R35 nicht mehr unterstützt.

Bauen Sie auf der Coupa-Plattform auf

Unsere API-basierte offene Integrationsplattform ermöglicht Technologiepartnern und unabhängigen Softwareanbietern (ISVs) die Integration ihrer Produkte in Coupa