OAuth 2.0: Neuen API-Proxy konfigurieren

Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zu Apigee X.
info

Wenn Sie die Apigee Cloud-Version von Edge verwenden, ist in Ihrer Organisation standardmäßig ein Proxy namens oauth enthalten. Dieser Proxy bietet zwei Beispielendpunkte zum Generieren von Zugriffs- und Aktualisierungstokens. Weitere Informationen zu OAuth-Token-Endpunkten finden Sie unter OAuth Endpunkte.

Mit dem Berechtigungstyp "Clientanmeldedaten" wird ein Verfahren zur Ausgabe von Zugriffstokens im Austausch für Anwendungsanmeldedaten festgelegt. Diese Anwendungsanmeldedaten sind das Consumer-Key und Secret Paar, das Apigee Edge für jede in einer Organisation registrierte Anwendung ausgibt. Weitere Informationen finden Sie unter Typ der Autorisierungscode-Zuweisung implementieren.

OAuth 2.0 zu einem neuen API-Proxy hinzufügen

Sie können einer API ganz einfach die OAuth-Überprüfung hinzufügen, wenn Sie einen neuen API-Proxy erstellen.

Edge

So fügen Sie einer API über die Edge-Benutzeroberfläche die OAuth-Überprüfung hinzu:

  1. Melden Sie sich unter apigee.com/edge an.
  2. Wählen Sie in der linken Navigationsleiste Develop > API Proxies aus.
  3. Klicken Sie auf +Proxy.
  4. Mit dem Assistenten "Proxy erstellen" können Sie einen Reverse-Proxy erstellen. Siehe Einfachen API-Proxy erstellen.
  5. Klicken Sie auf der Seite Allgemeine Richtlinien des Assistenten auf das Optionsfeld neben OAuth v2.0.

Classic Edge (Private Cloud)

So fügen Sie einer API über die Classic Edge-Benutzeroberfläche die OAuth-Überprüfung hinzu:

  1. Melden Sie sich unter http://ms-ip:9000 an. Dabei ist ms-ip die IP-Adresse oder der DNS-Name des Management Server-Knotens.
  2. Wählen Sie in der oberen Navigationsleiste APIs > API Proxies aus.
  3. Klicken Sie auf + API Proxy.
  4. Mit dem Assistenten "Proxy erstellen" können Sie einen Reverse-Proxy erstellen. Siehe Einfachen API Proxy erstellen.
  5. Klicken Sie auf der Seite Security (Sicherheit) des Assistenten auf das Optionsfeld neben OAuth v2.0.

Wenn Sie diese Option auswählen, werden dem neu erstellten API-Proxy zwei Richtlinien angehängt: eine zum Prüfen der Zugriffstokens und eine weitere, um das Zugriffstoken nach der Bestätigung zu entfernen.

Das Kästchen API-Produkt veröffentlichen ist auswählbar und wird automatisch ausgewählt. Klicken Sie dieses Kästchen an, wenn ein Produkt beim Erstellen des neuen API-Proxys automatisch generiert werden soll. Das automatisch erzeugte Produkt wird mit einer Verknüpfung zum neuen API-Proxy erstellt. Wenn Sie bereits ein Produkt haben, mit dem Sie diese neue API verknüpfen möchten, entfernen Sie das Häkchen aus diesem Kästchen, damit Sie kein unnötiges Produkt erstellen. Informationen zu Produkten finden Sie unter Was ist ein API-Produkt?

Mit dem standardmäßigen OAuth-Proxy arbeiten

Der OAuth-Proxy stellt den folgenden Endpunkt-URI zur Verfügung:

/oauth/client_credential/accesstoken

Veröffentlichen Sie diesen URI für Entwickler, die Zugriffstokens benötigen. App-Entwickler konfigurieren ihre Apps so, dass dieser Endpunkt aufgerufen wird. Dabei übergeben sie ihre Consumer-Schlüssel und Secret-Paare, um Zugriff stokens zu erhalten.

Der Standard-Token-Endpunkt der Clientanmeldedaten wird über das Netzwerk unter der folgenden URL bereitgestellt:

https://{org_name}-{env_name}.apigee.net/oauth/client_credential/accesstoken

Wenn der Name Ihrer Organisation beispielsweise "apimakers" ist, lautet die URL:

https://apimakers-test.apigee.net/oauth/client_credential/accesstoken

Dies ist die URL, die Entwickler aufrufen, um Zugriffstokens zu erhalten.

API aufrufen

Wenn Sie ein Zugriffstoken zurückerhalten, können Sie die API mit einem Autorisierungs-Header und einem Bearer-Token aufrufen:

curl -H "Authorization: Bearer <your access token>" http://myorg-myenv.apigee.net/myapi

Weitere Informationen erhalten Sie unter Zugriffstoken prüfen.