OAuth 2.0: Neuen API-Proxy konfigurieren

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation
weitere Informationen

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

Mit dem Berechtigungstyp "Clientanmeldedaten" wird ein Verfahren zur Ausgabe von Zugriffstokens im Austausch für Anwendungsanmeldedaten festgelegt. Diese App-Anmeldedaten sind das Consumer-Key-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 bei der Erstellung eines neuen API-Proxys ganz einfach eine OAuth-Überprüfung zu einer API hinzufügen.

Edge

So fügen Sie einer API mithilfe der Edge-Benutzeroberfläche die OAuth-Bestätigung 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. Wählen Sie auf der Seite Allgemeine Richtlinien im Assistenten das Optionsfeld neben OAuth v2.0 aus.

Classic Edge (Private Cloud)

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

  1. Melden Sie sich bei http://ms-ip:9000 an, wobei ms-ip die IP-Adresse oder der DNS-Name des Knotens des Verwaltungsservers ist.
  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. Wählen Sie auf der Seite Sicherheit des Assistenten das Optionsfeld neben OAuth v2.0 aus.

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 Standard-OAuth-Proxy arbeiten

Der OAuth-Proxy macht den folgenden Endpunkt-URI verfügbar:

/oauth/client_credential/accesstoken

Veröffentlichen Sie diesen URI für Entwickler, die Zugriffstokens anfordern müssen. App-Entwickler konfigurieren ihre Apps so, dass dieser Endpunkt aufgerufen wird. Dabei präsentieren sie ihre Consumer-Key- und -Secret-Paare, um Zugriffstokens 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 erhalten, können Sie die API mit einem Autorisierungsheader und einem Inhabertoken wie folgt aufrufen:

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

Weitere Informationen erhalten Sie unter Zugriffstoken prüfen.