Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an. info
Die Monetarisierung bietet eine Reihe von APIs, mit denen Sie die Sperrung eines zuvor gesperrten Entwicklers aufheben können, wie in den folgenden Abschnitten beschrieben. Ein Entwickler kann gesperrt werden, wenn ein konfiguriertes Limit erreicht wird. Dies kann beispielsweise der Fall sein, wenn die Anzahl der Transaktionen das Limit erreicht hat oder ein Prepaidguthaben aufgebraucht ist. Eine vollständige Liste der Gründe finden Sie unter Zusammenfassung der Gründe für die Sperrung von Entwicklern.
Alle gesperrten Entwickler aufrufen, die die API verwenden
Alle gesperrten Entwickler für eine Organisation ansehen, indem Sie eine GET-Anfrage an die folgende Ressource senden: /organizations/{org_name}/suspended-developers
.
Wobei:
{org_name}
gibt den Namen der Organisation an.
Der folgende cURL-Aufruf listet beispielsweise alle gesperrten Entwickler für myorg
auf:
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 ein Beispiel für eine Antwort:
[ { "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" } ]
Daten zu einem gesperrten Entwickler mit der API aufrufen
Wenn Sie einen gesperrten Entwickler für eine Organisation aufrufen möchten, senden Sie eine GET-Anfrage an die folgende Ressource: /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.
Im folgenden cURL-Aufruf werden beispielsweise Details für den gesperrten Entwickler joe@example.com
aufgeführt:
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 ein Beispiel für eine Antwort:
[ { "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 mithilfe der API aufheben
Sie können die Sperrung aller Entwickler aufheben, die für ein API-Produkt gesperrt wurden, 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 ähnlichen Format wie{org_id}@@@{product_id}
an. Dieser Wert wird alsprodId
zurückgegeben, wenn Sie alle oder bestimmte gesperrte Entwickler aufrufen, wie unter Alle gesperrten Entwickler ansehen, die die API verwenden und Gesperrten Entwickler mithilfe der API aufrufen beschrieben.
Mit dem folgenden cURL-Aufruf wird beispielsweise die Sperrung für alle Entwickler für das API-Produkt myorg@@@myproduct
aufgehoben:
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 mithilfe der API aufheben
Heben Sie die Sperrung eines bestimmten Entwicklers auf, der gesperrt wurde. Senden Sie dazu eine DELETE-Anfrage an die folgende Ressource: /organizations/{org_name}/suspended-developers/{suspendedDev_id}.
Wobei:
{org_name}
gibt den Namen der Organisation an.{suspendedDev_id}
gibt die ID des gesperrten Entwicklers in einem ähnlichen Format wie{org_id}@@@{dev_id}
an. Dieser Wert wird alsdevId
zurückgegeben, wenn Sie alle oder bestimmte gesperrte Entwickler aufrufen, wie unter Alle gesperrten Entwickler mithilfe der API aufrufen und Einen gesperrten Entwickler mithilfe der API aufrufen beschrieben.
Optional können Sie den folgenden Abfrageparameter übergeben:
Suchparameter | Beschreibung |
---|---|
suspendedProduct_id |
ID des API-Produkts im 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 mithilfe der API aufrufen und Einen gesperrten Entwickler mithilfe der API aufrufen 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 Begründungscodes für gesperrte Entwickler
In der folgenden Tabelle sind die Gründe für die Sperrung eines Entwicklers aufgeführt.
Ursachencode | Beschreibung |
---|---|
INSUFFICIENT_FUNDS |
Das Entwicklerkonto ist aufgebraucht. |
LIMIT_VIOLATED |
Das konfigurierte Limit für das Entwicklerkonto wurde erreicht. |
NO_CURRENT_PUBLISHABLE_ENTITY |
Der Entwickler hat keinen Preisplan akzeptiert (bzw. keinen Preisplan abonniert). |
RATE_PLAN_RATE_BAND_EXCEEDED |
Das konfigurierte Limit des letzten Lautstärkebereichs wurde erreicht. |