Erste Schritte mit der Apigee API

Sie lesen die Dokumentation zu Apigee X.
Apigee Edge-Dokumentation aufrufen

Die Apigee API kann verwendet werden, um APIs mit einer Reihe von RESTful-Vorgängen zu entwickeln und zu verwalten.

Sie können die Apigee API verwenden, um die API-Proxy-Verwaltung in den Softwareentwicklungslebenszyklus Ihrer Organisation zu integrieren. Eine gängige Verwendung der Apigee API besteht darin, Skripts oder Code zu schreiben, die API-Proxys bereitstellen oder API-Proxys von einer Umgebung in eine andere migrieren, wenn auch andere Anwendungen bereitgestellt oder migriert werden.

Weitere Informationen finden Sie unter Apigee API.

Apigee API aktivieren

Prüfen Sie, ob die Apigee API aktiviert ist. Am einfachsten aktivieren Sie APIs für Ihr Projekt mit der Google Cloud Console. Weitere Informationen finden Sie unter Schritt 3: APIs aktivieren.

OAuth 2.0-Zugriffstoken abrufen

Die Apigee API unterstützt OAuth 2.0 für die Nutzerauthentifizierung. Mit OAuth 2.0 tauschen Sie Ihre Google Cloud-Anmeldedaten gegen ein Zugriffstoken aus, mit dem Sie anschließend sichere Aufrufe der Apigee API machen können. Sobald Sie ein Token erhalten, müssen Sie Ihre Anmeldeinformationen nicht erneut austauschen, bis das Token abläuft.

Token mit Google Cloud-Anmeldedaten abrufen

So rufen Sie ein Token mit Ihren Google Cloud-Anmeldedaten ab:

  1. So autorisieren Sie gcloud mit Ihren Google-Nutzeranmeldedaten, um auf die Cloud Platform zuzugreifen:
    gcloud auth login
  2. Rufen Sie ein Token für das derzeit aktive Konto ab:
    export TOKEN=$(gcloud auth print-access-token)
  3. Wenn Sie eine Apigee API aufrufen, übergeben Sie das Zugriffstoken im Autorisierungsheader. Beispiel:
    curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $TOKEN"

Token mit einem Google Cloud-Dienstkontoschlüssel abrufen

So rufen Sie ein Token mit einem Dienstkontoschlüssel für die Autorisierung ab:

  1. Generieren Sie einen Schlüssel für Ihr Dienstkonto mithilfe der GCP Console, wie unter Dienstkontoschlüssel erstellen und verwalten beschrieben.

    Eine JSON-Datei mit den Anmeldedaten Ihres Dienstkontos wird auf Ihren Computer heruntergeladen.

  2. Mithilfe Ihrer Google Cloud-Anmeldedaten können Sie ein OAuth 2.0-Zugriffstoken mit Aufrufen an die Apigee API mithilfe einer der folgenden Methoden übergeben:

    gcloud

    Verwenden Sie gcloud, um ein OAuth 2.0-Zugriffstoken abzurufen, und übergeben Sie die JSON-Datei für die Dienstkonto-Anmeldedaten, die Sie in Schritt 1 mit der Umgebungsvariablen GOOGLE_APPLICATION_CREDENTIALS heruntergeladen haben. Weitere Informationen finden Sie unter gcloud auth application-default print-access-token.

    export GOOGLE_APPLICATION_CREDENTIALS=~/sa-credentials-file.json
    gcloud auth application-default print-access-token

    Dienstprogramm "oauth2l"

    Rufen Sie mit oauth2l ein OAuth 2.0-Zugriffstoken ab und übergeben Sie die JSON-Datei mit den Anmeldedaten für das Dienstkonto, die Sie in Schritt 1 heruntergeladen haben.

    oauth2l fetch --json ~/sa-credentials-file.json cloud-platform

    Ein OAuth2.0-Token wird zurückgegeben.

  3. Kopieren Sie das zurückgegebene Token und speichern Sie es in einer Variablen wie TOKEN. Beispiel:
    export TOKEN=ya29....Ts13inj3LrqMJlztwygtM
  4. Wenn Sie eine Apigee API aufrufen, übergeben Sie das Zugriffstoken im Autorisierungsheader. Beispiel:
    curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $TOKEN"

Umgebungsvariablen für Apigee API-Anfragen festlegen

Die in der Dokumentation aufgeführten Beispiele zur Apigee API und zur gcloud-Befehlszeile verwenden eine oder mehrere Umgebungsvariablen, die in der folgenden Tabelle definiert sind.

Wenn Sie die Umgebungsvariablen vorab in aussagekräftige Werte in Ihrer Umgebung umwandeln, können Sie die Beispielanfragen kopieren und einfügen, um sie mit minimaler oder gar keiner Änderung in Ihrer eigenen Umgebung auszuführen.

Umgebungsvariable Beschreibung
$API Name Ihres API-Proxys.
$APIPRODUCT Name des API-Produkts.
$APP ID einer App.
$DEVELOPER_EMAIL E-Mail-Adresse des Entwicklers.
$ENV Name Ihrer Umgebung, z. B. test oder prod.
$ID Ressourcen-ID.
$KEY Consumer-Key.
$NAME Name der Ressource.
$ORG Ihre Apigee-Organisation.
$REV Überarbeitungsnummer Ihres API-Proxys.
$SHAREDFLOW Name des freigegebenen Ablaufs.
$TYPE Ressourcentyp.

cURL verwenden

In den Beispielen in diesem Abschnitt wird mit curl gezeigt, wie Anwendungen mit der Apigee API entwickelt werden. curl ist ein Open-Source-Befehlszeilentool zum Übertragen von Daten mit URL-Syntax, das gängige Protokolle wie HTTP und HTTPS unterstützt.

In der folgenden Tabelle sind die in den Beispielen verwendeten Befehlszeilenoptionen zusammengefasst.

Option Beschreibung
-d '{}' --data @filename
--data-binary @filename
Definiert den Anfragetext, den Sie direkt oder durch Angabe eines Dateinamens weitergeben können.
-F file=@filename
--form file=@filename
Definiert formularbasierte Daten, die Sie durch Angabe eines Dateinamens übergeben können.
-H
--header
Definiert einen Anforderungsheader.

Im Anfrageheader müssen folgende Informationen übergeben werden:

  • Authorization-Header: OAuth 2.0-Token für die Nutzerauthentifizierung, wie unter OAuth 2.0-Zugriffstoken abrufen beschrieben.
  • Content-Type-Header: Inhaltstyp des Anfragetexts, der gesendet wird, wenn eine Ressource mithilfe von API erstellt oder aktualisiert wird (POST, PATCH, PUT).
-X Gibt den Anfragetyp an (GET, POST usw.).

Beispiel:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis" \
   -X GET \
   -H "Authorization: Bearer $TOKEN"

Dabei ist $TOKEN auf Ihr OAuth 2.0-Zugriffstoken festgelegt. Weitere Informationen hierzu finden Sie unter OAuth 2.0-Zugriffstoken abrufen.