Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur
Dokumentation zuApigee X wechseln. info
Die Monetarisierung bietet eine Reihe von APIs, mit denen Sie einen zuvor gesperrten Entwickler entsperren können, wie in den folgenden Abschnitten beschrieben. Ein Entwickler kann gesperrt werden, wenn ein konfiguriertes Limit erreicht wird. Beispielsweise wurde das Limit für die Anzahl der Transaktionen erreicht oder das Guthaben eines Prepaid-Kontos ist aufgebraucht. Eine vollständige Liste der Ursachencodes finden Sie unter Zusammenfassung der Ursachencodes für gesperrte Entwickler.
Alle gesperrten Entwickler mit der API ansehen
Wenn Sie alle gesperrten Entwickler für eine Organisation ansehen möchten, senden Sie eine GET-Anfrage an die folgende
Ressource: /organizations/{org_name}/suspended-developers.
Wobei:
{org_name}gibt den Namen der Organisation an.
Mit dem 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 ein Beispiel für die 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"
}
]
Gesperrten Entwickler mit der API ansehen
Wenn Sie einen gesperrten Entwickler für eine Organisation ansehen 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.
Mit dem folgenden cURL-Aufruf werden beispielsweise Details für den gesperrten Entwickler
joe@example.com aufgelistet:
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 die 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"
}
]
Alle Entwickler für ein API-Produkt mit der API entsperren
Wenn Sie alle Entwickler entsperren möchten, die für ein API-Produkt gesperrt wurden, senden Sie eine POST-Anfrage
an die folgende Ressource:
/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 ähnlich dem folgenden an:{org_id}@@@{product_id}. Dieser Wert wird alsprodIdzurückgegeben, wenn Sie alle oder bestimmte gesperrte Entwickler ansehen, wie unter Alle gesperrten Entwickler mit der API ansehen und Gesperrten Entwickler mit der 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
Entwickler mit der API entsperren
Wenn Sie einen bestimmten gesperrten Entwickler entsperren möchten, senden Sie 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 Format ähnlich dem folgenden an:{org_id}@@@{dev_id}. Dieser Wert wird alsdevIdzurückgegeben, wenn Sie alle oder bestimmte gesperrte Entwickler ansehen, wie unter Alle gesperrten Entwickler mit der API ansehen und Gesperrten Entwickler mit der API ansehen beschrieben.
Optional können Sie den folgenden Abfrageparameter übergeben:
| Suchparameter | Beschreibung |
|---|---|
suspendedProduct_id |
ID des API-Produkts in einem Format ähnlich dem folgenden:
{org_id}@@@{product_id}. Dieser Wert wird als prodId zurückgegeben, wenn
Sie alle oder bestimmte gesperrte Entwickler ansehen, wie unter Alle gesperrten Entwickler mit der API ansehen und Gesperrten Entwickler mit der API ansehen beschrieben. |
Mit dem folgenden cURL-Aufruf wird beispielsweise der Entwickler mit der ID
myorg@@@6Vro7VnjUhpGVn3p für das API-Produkt myorg@@@myproduct entsperrt:
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 zusammengefasst, die angeben, warum ein Entwickler gesperrt wurde.
| 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 kein Tarifpaket akzeptiert (abonniert). |
RATE_PLAN_RATE_BAND_EXCEEDED |
Das konfigurierte Limit des letzten Mengenbands wurde erreicht. |