Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen
Zur Monetarisierung sind verschiedene APIs verfügbar, mit denen Sie die Sperrung eines Entwicklers aufheben können, wie in den folgenden Abschnitten beschrieben. Ein Entwickler kann gesperrt werden, wenn ein konfiguriertes Limit erreicht wird. Es kann beispielsweise sein, dass die Anzahl der Transaktionen die Höchstgrenze erreicht hat oder ein Prepaidguthaben auf dem Konto aufgebraucht ist. Eine vollständige Liste der Ursachencodes finden Sie unter Zusammenfassung der Ursachencodes für gesperrte Entwickler.
Alle gesperrten Entwickler über die API ansehen
Sehen Sie sich alle gesperrten Entwickler für eine Organisation an, indem Sie eine GET-Anfrage an die folgende Ressource senden: /organizations/{org_name}/suspended-developers
.
Wobei:
{org_name}
gibt den Namen der Organisation an.
Im folgenden cURL-Aufruf werden beispielsweise alle gesperrten Entwickler für myorg
aufgelistet:
curl -H "Content-Type: application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers" \ -u email:password
Im Folgenden finden Sie eine Beispielantwort:
[ { "creationDate": 1464388723633, "devId": "myorg@@@6Vro7VnjUhpGVn3p", "id": "myorg-myorg@@@6Vro7VnjUhpGVn3p-myorg@@@myproduct-null-RATE_PLAN_RATE_BAND_EXCEEDED", "message": "mint.productHasBeenSuspended for myorg@@@6Vro7VnjUhpGVn3p myorg@@@myproduct due to RATE_PLAN_RATE_BAND_EXCEEDED", "orgId": "myorg", "prodId": "myorg@@@myproduct", "reasonCode": "RATE_PLAN_RATE_BAND_EXCEEDED" }, { "creationDate": 1464022846293, "devId": "myorg@@@vXh7LXxtUy9COVdy", "id": "myorg-myorg@@@vXh7LXxtUy9COVdy-myorg@@@myproduct-null-NO_CURRENT_PUBLISHABLE_ENTITY", "message": "mint.productHasBeenSuspended for myorg@@@vXh7LXxtUy9COVdy myorg@@@myproduct due to mint.noCurrentPublishableEntity", "orgId": "myorg", "prodId": "myorg@@@myproduct", "reasonCode": "NO_CURRENT_PUBLISHABLE_ENTITY" } ]
Gesperrten Entwickler über die API ansehen
Sie können sich einen gesperrten Entwickler für eine Organisation ansehen, indem Sie eine GET-Anfrage an die folgende Ressource senden: /organizations/{org_name}/suspended-developers/{developer_email_or_id}
.
Wobei:
{org_name}
gibt den Namen der Organisation an.{developer_email_or_id}
gibt die ID des Entwicklers an. Eine Liste der Entwickler finden Sie unter Entwickler auflisten.
Der folgende cURL-Aufruf listet beispielsweise Details für den gesperrten Entwickler joe@example.com
auf:
curl -H "Content-Type: application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/joe@example.com" \ -u email:password
Im Folgenden finden Sie eine Beispielantwort:
[ { "creationDate": 1464388723633, "devId": "myorg@@@6Vro7VnjUhpGVn3p", "id": "myorg-myorg@@@6Vro7VnjUhpGVn3p-myorg@@@myproduct-null-RATE_PLAN_RATE_BAND_EXCEEDED", "message": "mint.productHasBeenSuspended for myorg@@@6Vro7VnjUhpGVn3p myorg@@@myproduct due to RATE_PLAN_RATE_BAND_EXCEEDED", "orgId": "myorg", "prodId": "myorg@@@myproduct", "reasonCode": "RATE_PLAN_RATE_BAND_EXCEEDED" } ]
Sperrung aller Entwickler für ein API-Produkt über die API aufheben
Geben Sie die Sperrung aller für ein API-Produkt gesperrten Entwickler frei, indem Sie eine POST-Anfrage an die folgende Ressource senden: /organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id}
.
Wobei:
{org_name}
gibt den Namen der Organisation an.{suspendedProduct_id}
gibt die ID des API-Produkts in einem Format wie dem folgenden an:{org_id}@@@{product_id}
. Dieser Wert wird alsprodId
zurückgegeben, wenn Sie alle oder bestimmte gesperrte Entwickler aufrufen, wie unter Alle gesperrten Entwickler mit der API ansehen und Gesperrten Entwickler über die API ansehen beschrieben.
Mit dem folgenden cURL-Aufruf werden beispielsweise alle Entwickler für das API-Produkt myorg@@@myproduct
entsperrt:
curl -H "Content-Type: application/json" -X POST \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/unsuspend-by-product/myorg@@@myproduct" \ -u email:password
Sperrung eines Entwicklers über die API aufheben
Geben Sie die Sperrung eines bestimmten Entwicklers frei, indem Sie eine DELETE-Anfrage an die folgende Ressource senden: /organizations/{org_name}/suspended-developers/{suspendedDev_id}.
Wobei:
{org_name}
gibt den Namen der Organisation an.{suspendedDev_id}
gibt die ID des gesperrten Entwicklers an. Das Format sieht etwa so aus:{org_id}@@@{dev_id}
. Dieser Wert wird alsdevId
zurückgegeben, wenn Sie alle oder bestimmte gesperrte Entwickler aufrufen, wie unter Alle gesperrten Entwickler mit der API ansehen und Gesperrten Entwickler über die API ansehen beschrieben.
Optional können Sie den folgenden Abfrageparameter übergeben:
Suchparameter | Beschreibung |
---|---|
suspendedProduct_id |
ID des API-Produkts in einem ähnlichen Format: {org_id}@@@{product_id} . Dieser Wert wird als prodId zurückgegeben, wenn Sie alle oder bestimmte gesperrte Entwickler aufrufen, wie unter Alle gesperrten Entwickler mit der API ansehen und Gesperrten Entwickler über die API ansehen beschrieben. |
Mit dem folgenden cURL-Aufruf wird beispielsweise die Sperrung des Entwicklers mit der ID myorg@@@6Vro7VnjUhpGVn3p
für das API-Produkt myorg@@@myproduct
aufgehoben:
curl -H "Content-Type: application/json" -X DELETE \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/myorg@@@6Vro7VnjUhpGVn3p?productId=myorg@@@myproduct" \ -u email:password
Zusammenfassung der Ursachencodes für gesperrte Entwickler
In der folgenden Tabelle sind die Ursachencodes aufgeführt, die angeben, warum ein Entwickler gesperrt wurde.
Ursachencode | Beschreibung |
---|---|
INSUFFICIENT_FUNDS |
Das Entwicklerkonto wurde aufgebraucht. |
LIMIT_VIOLATED |
Das konfigurierte Limit für das Entwicklerkonto wurde erreicht. |
NO_CURRENT_PUBLISHABLE_ENTITY |
Der Entwickler hat einen Preisplan nicht akzeptiert bzw. abonniert. |
RATE_PLAN_RATE_BAND_EXCEEDED |
Das konfigurierte Limit für das endgültige Lautstärkeband wurde erreicht. |