API-Produktabos über die API erwerben und verwalten

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Wenn Sie Ihr eigenes benutzerdefiniertes Portal erstellen oder den Kaufprozess manuell verwalten möchten, wird in den folgenden Abschnitten beschrieben, wie Sie API-Produktabos mithilfe der API erwerben und verwalten können. In diesen Beispielen wird beschrieben, wie Sie Abos für App-Entwickler und AppGroups verwalten.

Weitere Informationen finden Sie unter Integrieren Sie die Monetarisierung von Apigee in Ihr Drupal-Entwicklerportal.

Aboverwaltung für App-Entwickler

App-Entwickler: API-Produktabos über die API erwerben

Senden Sie eine POST-Anfrage an die folgende API, um ein API-Produktabo zu kaufen: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

Konfigurieren Sie die API-Produktaboanfrage. Füllen Sie dazu die erforderlichen Felder im Anfragetext aus, wie unter Ressource: Abos beschrieben.

Mit dem folgenden API-Aufruf wird beispielsweise ein Abo des API-Produkts HelloworldProduct für den angegebenen Entwickler erworben: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{"apiproduct":"HelloworldProduct"}'

Dabei ist $TOKEN auf Ihr OAuth 2.0-Zugriffstoken festgelegt, wie unter OAuth 2.0-Zugriffstoken abrufen beschrieben. Informationen zu den in diesem Beispiel verwendeten curl-Optionen finden Sie unter curl verwenden. Eine Beschreibung der Umgebungsvariablen, die Sie verwenden können, finden Sie unter Umgebungsvariablen für Apigee API-Anfragen festlegen.

Im Folgenden finden Sie ein Beispiel für die Antwortausgabe. startTime ist auf die aktuelle Zeit eingestellt.

{
   "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
   "apiproduct": "HelloworldProduct",
   "startTime": "1615987132000",
   "createdAt": "1615903252000",
   "lastModifiedAt": "1615903252000"
}

Weitere Informationen finden Sie in der API-Produktabo kaufen.

App-Entwickler: API-Produktabo sofort ablaufen lassen

Wenn Sie ein API-Produktabo sofort erneuern möchten, senden Sie eine POST-Anfrage an die folgende API: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/$SUBSCRIPTION:expire

Mit dem folgenden API-Aufruf läuft beispielsweise das API-Produktabo mit dem Namen 69f8bb42-a8e4-4a2c-b932-d82b51d37b72 für den angegebenen Entwickler ab: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/69f8bb42-a8e4-4a2c-b932-d82b51d37b72:expire" \
  -X POST \
  -H "Authorization: Bearer $TOKEN"

Dabei ist $TOKEN auf Ihr OAuth 2.0-Zugriffstoken festgelegt, wie unter OAuth 2.0-Zugriffstoken abrufen beschrieben. Informationen zu den in diesem Beispiel verwendeten curl-Optionen finden Sie unter curl verwenden. Eine Beschreibung der Umgebungsvariablen, die Sie verwenden können, finden Sie unter Umgebungsvariablen für Apigee API-Anfragen festlegen.

Im Folgenden finden Sie ein Beispiel für die Antwortausgabe. endTime ist auf die aktuelle Zeit eingestellt.

{
  "name": "33f8dd42-c7x5-3s3f-b098-d=c93h22m36b47",
  "apiproduct": "WeatherReport",
  "startTime": "1613494852000",
  "endTime" : "1617894954000",
  "createdAt": "1613494852000",
  "lastModifiedAt": "1613494852000"
}

App-Entwickler: Alle API-Produktabos für einen Entwickler auflisten

Wenn Sie alle API-Produktabos für einen Entwickler auflisten möchten, senden Sie eine GET-Anfrage an die folgende API: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

Sie können die folgenden Felder übergeben, um die Paginierung zu unterstützen:

  • startKey, um den Namen des API-Produktabos anzugeben, ab dem die Liste der Abos angezeigt werden soll. Wird kein Wert angegeben, beginnt die Liste ab dem ersten Element. Verwenden Sie count, um das Filtern präziser zu gestalten. Wenn Sie beispielsweise die API-Produktabos von 51 bis 150 ansehen möchten, setzen Sie den Wert von startKey auf den Namen des 51. Abos und legen Sie den Wert von count auf 100 fest.
  • count, um die Anzahl der Tarifpläne anzugeben, die im API-Aufruf zurückgegeben werden sollen. Verwenden Sie startKey, um das Filtern präziser zu gestalten. Die Höchstzahl liegt bei 1.000. Die Standardeinstellung ist 100.

Der folgende API-Aufruf listet beispielsweise alle API-Produktabos für den angegebenen Entwickler auf: 

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

Dabei ist $TOKEN auf Ihr OAuth 2.0-Zugriffstoken festgelegt, wie unter OAuth 2.0-Zugriffstoken abrufen beschrieben. Informationen zu den in diesem Beispiel verwendeten curl-Optionen finden Sie unter curl verwenden. Eine Beschreibung der Umgebungsvariablen, die Sie verwenden können, finden Sie unter Umgebungsvariablen für Apigee API-Anfragen festlegen.

Im Folgenden finden Sie ein Beispiel für die Antwortausgabe:

{
  "developerSubscriptions": [
    {
      "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
      "apiproduct": "HelloworldProduct",
      "startTime": "1615987132000",
      "createdAt": "1615903252000",
      "lastModifiedAt": "1615903252000"
    },
    {
      "name": "33f8dd42-c7x5-3s3f-b098-d=c93h22m36b47",
      "apiproduct": "WeatherReport",
      "startTime": "1614124552000",
      "createdAt": "1613494852000",
      "lastModifiedAt": "1613494852000"
    }
  ]
}

Weitere Informationen finden Sie unter API-Produktabos auflisten.

Anwendungsentwickler: Details zu einem API-Produktabo ansehen

Wenn Sie Details zu einem API-Produktabo für einen Entwickler ansehen möchten, senden Sie eine GET-Anfrage an die folgende API: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/$SUBSCRIPTION

Mit dem folgenden API-Aufruf werden beispielsweise Details zu einem API-Produktabo für den angegebenen Entwickler abgerufen: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/69f8bb42-a8e4-4a2c-b932-d82b51d37b72" \
  -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. Informationen zu den in diesem Beispiel verwendeten curl-Optionen finden Sie unter curl verwenden. Eine Beschreibung der Umgebungsvariablen, die Sie verwenden können, finden Sie unter Umgebungsvariablen für Apigee API-Anfragen festlegen.

Im Folgenden finden Sie ein Beispiel für die Antwortausgabe:

{
   "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
   "apiproduct": "HelloworldProduct",
   "startTime": "1615987132000",
   "createdAt": "1615903252000",
   "lastModifiedAt": "1615903252000"
}

Weitere Informationen finden Sie unter API-Produktabo abrufen.

AppGroup-Abos verwalten

In diesem Abschnitt finden Sie Beispiele für die Verwaltung von API-Produktabos für AppGroups. Weitere Informationen zu den APIs, die zum Verwalten von AppGroup-Abos verwendet werden, finden Sie unter Ressource: Abos.

AppGroup: API-Produktabos über die API erwerben

Informationen zu den Anforderungen für die Verwendung von AppGroups mit API-Produktabos finden Sie unter AppGroups zum Verwalten von API-Produktabos verwenden.

Wenn Sie ein API-Produktabo kaufen möchten, senden Sie eine POST-Anfrage an die folgende API: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions.

Konfigurieren Sie die API-Produktaboanfrage. Füllen Sie dazu die erforderlichen Felder im Anfragetext aus, wie unter Ressource: Abos beschrieben.

Mit dem folgenden API-Aufruf wird beispielsweise ein Abo des API-Produkts HelloworldProduct für die angegebene App-Gruppe erworben: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{"apiproduct":"HelloworldProduct"}'

Dabei ist $TOKEN auf Ihr OAuth 2.0-Zugriffstoken festgelegt. Weitere Informationen hierzu finden Sie unter OAuth 2.0-Zugriffstoken abrufen. Informationen zu den in diesem Beispiel verwendeten curl-Optionen finden Sie unter curl verwenden. Eine Beschreibung der Umgebungsvariablen, die Sie verwenden können, finden Sie unter Umgebungsvariablen für Apigee API-Anfragen festlegen.

Im Folgenden finden Sie ein Beispiel für die Antwortausgabe. startTime ist auf die aktuelle Zeit eingestellt.

{
   "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
   "apiproduct": "HelloworldProduct",
   "startTime": "1615987132000",
   "createdAt": "1615903252000",
   "lastModifiedAt": "1615903252000"
}

Weitere Informationen finden Sie in der API-Produktabo kaufen.

AppGroup: API-Produktabo sofort ablaufen lassen

Wenn Sie ein API-Produktabo sofort erneuern möchten, senden Sie eine POST-Anfrage an die folgende API: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions/$SUBSCRIPTION:expire

Mit dem folgenden API-Aufruf läuft beispielsweise das API-Produktabo mit dem Namen 69f8bb42-a8e4-4a2c-b932-d82b51d37b72 für die angegebene App-Gruppe ab: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions/69f8bb42-a8e4-4a2c-b932-d82b51d37b72:expire" \
  -X POST \
  -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. Informationen zu den in diesem Beispiel verwendeten curl-Optionen finden Sie unter curl verwenden. Eine Beschreibung der Umgebungsvariablen, die Sie verwenden können, finden Sie unter Umgebungsvariablen für Apigee API-Anfragen festlegen.

Im Folgenden finden Sie ein Beispiel für die Antwortausgabe. endTime ist auf die aktuelle Zeit eingestellt.

{
  "name": "33f8dd42-c7x5-3s3f-b098-d=c93h22m36b47",
  "apiproduct": "WeatherReport",
  "startTime": "1613494852000",
  "endTime" : "1617894954000",
  "createdAt": "1613494852000",
  "lastModifiedAt": "1613494852000"
}

AppGroup: Alle API-Produktabos auflisten

Wenn Sie alle API-Produktabos für eine AppGroup auflisten möchten, senden Sie eine GET-Anfrage an die folgende API: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions

Sie können die folgenden Felder übergeben, um die Paginierung zu unterstützen:

  • startKey, um den Namen des API-Produktabos anzugeben, ab dem die Liste der Abos angezeigt werden soll. Wird kein Wert angegeben, beginnt die Liste ab dem ersten Element. Verwenden Sie count, um das Filtern präziser zu gestalten. Wenn Sie beispielsweise die API-Produktabos von 51 bis 150 ansehen möchten, setzen Sie den Wert von startKey auf den Namen des 51. Abos und legen Sie den Wert von count auf 100 fest.
  • count, um die Anzahl der Tarifpläne anzugeben, die im API-Aufruf zurückgegeben werden sollen. Verwenden Sie startKey, um das Filtern präziser zu gestalten. Die Höchstzahl liegt bei 1.000. Die Standardeinstellung ist 100.

Der folgende API-Aufruf listet beispielsweise alle API-Produktabos für die angegebene AppGroup auf: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions" \
  -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. Informationen zu den in diesem Beispiel verwendeten curl-Optionen finden Sie unter curl verwenden. Eine Beschreibung der Umgebungsvariablen, die Sie verwenden können, finden Sie unter Umgebungsvariablen für Apigee API-Anfragen festlegen.

Im Folgenden finden Sie ein Beispiel für die Antwortausgabe:

{
  "appGroupSubscriptions": [
    {
      "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
      "apiproduct": "HelloworldProduct",
      "startTime": "1615987132000",
      "createdAt": "1615903252000",
      "lastModifiedAt": "1615903252000"
    },
    {
      "name": "33f8dd42-c7x5-3s3f-b098-d=c93h22m36b47",
      "apiproduct": "WeatherReport",
      "startTime": "1614124552000",
      "createdAt": "1613494852000",
      "lastModifiedAt": "1613494852000"
    }
  ]
}

Weitere Informationen finden Sie unter API-Produktabos auflisten.

AppGroup: Details zu einem API-Produktabo ansehen

Wenn Sie Details zu einem API-Produktabo für eine App-Gruppe ansehen möchten, senden Sie eine GET-Anfrage an die folgende API: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions/$SUBSCRIPTION

Der folgende API-Aufruf listet beispielsweise Informationen zu einem API-Produktabo für eine bestimmte AppGroup auf: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions/69f8bb42-a8e4-4a2c-b932-d82b51d37b72" \
  -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. Informationen zu den in diesem Beispiel verwendeten curl-Optionen finden Sie unter curl verwenden. Eine Beschreibung der Umgebungsvariablen, die Sie verwenden können, finden Sie unter Umgebungsvariablen für Apigee API-Anfragen festlegen.

Im Folgenden finden Sie ein Beispiel für die Antwortausgabe:

{
   "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
   "apiproduct": "HelloworldProduct",
   "startTime": "1615987132000",
   "createdAt": "1615903252000",
   "lastModifiedAt": "1615903252000"
}

Weitere Informationen finden Sie unter API-Produktabo abrufen.