Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info
W sekcji Generowanie przychodu dostępny jest zestaw interfejsów API, za pomocą których możesz anulować zawieszenie konta dewelopera, co zostało opisane w sekcjach poniżej. Deweloper może zostać zawieszony, jeśli osiągnie skonfigurowany limit. Może to być na przykład spowodowane osiągnięciem maksymalnej liczby transakcji lub wyczerpaniem salda na koncie przedpłaconym. Pełną listę kodów przyczyn znajdziesz w artykule Podsumowanie kodów przyczyn zawieszenia konta dewelopera.
Wyświetlanie wszystkich zawieszonych deweloperów za pomocą interfejsu API
Aby wyświetlić wszystkich zawieszonych deweloperów w organizacji, wyślij żądanie GET do tego zasobu: /organizations/{org_name}/suspended-developers
.
Gdzie:
{org_name}
określa nazwę organizacji.
Na przykład to wywołanie cURL wyświetla listę wszystkich zawieszonych deweloperów w przypadku myorg
:
curl -H "Content-Type: application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers" \ -u email:password
Oto przykład odpowiedzi:
[ { "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" } ].
Wyświetlanie zawieszonego dewelopera korzystającego z interfejsu API
Aby wyświetlić zawieszonego dewelopera w organizacji, wyślij żądanie GET do tego zasobu:
/organizations/{org_name}/suspended-developers/{developer_email_or_id}
.
Gdzie:
{org_name}
określa nazwę organizacji.{developer_email_or_id}
określa identyfikator dewelopera. Aby wyświetlić listę deweloperów, zapoznaj się z sekcją Tworzenie listy deweloperów.
Na przykład to wywołanie cURL zawiera szczegółowe informacje dotyczące zawieszonego dewelopera joe@example.com
:
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
Poniżej znajdziesz przykładową odpowiedź:
[ { "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" } ].
przywrócenie wszystkich deweloperów do usługi API korzystającej z interfejsu API;
Odwiesz wszystkich deweloperów, którzy zostali zawieszeni w przypadku produktu interfejsu API, wysyłając żądanie POST do tego zasobu:
/organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id}
.
Gdzie:
{org_name}
określa nazwę organizacji.{suspendedProduct_id}
określa identyfikator usługi interfejsu API w formacie podobnym do tego:{org_id}@@@{product_id}
. Ta wartość jest zwracana jakoprodId
, gdy wyświetlasz wszystkich lub konkretnych zawieszonych deweloperów, jak opisano w artykułach Wyświetlanie wszystkich zawieszonych deweloperów za pomocą interfejsu API i Wyświetlanie zawieszonego dewelopera za pomocą interfejsu API.
Na przykład to wywołanie cURL odwiesza wszystkich programistów w przypadku produktu interfejsu API:
myorg@@@myproduct
:
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
Anulowanie zawieszeń dewelopera korzystających z interfejsu API
Odblokuj konkretnego dewelopera, który został zawieszony, wysyłając żądanie DELETE do tego zasobu: /organizations/{org_name}/suspended-developers/{suspendedDev_id}.
Gdzie:
{org_name}
określa nazwę organizacji.{suspendedDev_id}
określa identyfikator zawieszonego dewelopera w formacie podobnym do tego:{org_id}@@@{dev_id}
. Ta wartość jest zwracana jakodevId
, gdy wyświetlasz wszystkich lub konkretnych zawieszonych deweloperów, jak opisano w artykułach Wyświetlanie wszystkich zawieszonych deweloperów za pomocą interfejsu API i Wyświetlanie zawieszonego dewelopera za pomocą interfejsu API.
Opcjonalnie możesz przekazać ten parametr zapytania:
Parametr zapytania | Opis |
---|---|
suspendedProduct_id |
Identyfikator usługi interfejsu API w formacie podobnym do tego:{org_id}@@@{product_id} . Ta wartość jest zwracana jako prodId , gdy wyświetlasz wszystkich lub konkretnych zawieszonych deweloperów, jak opisano w artykułach Wyświetlanie wszystkich zawieszonych deweloperów za pomocą interfejsu API i Wyświetlanie zawieszonego dewelopera za pomocą interfejsu API. |
Na przykład to wywołanie cURL cofa zawieszenie dewelopera o identyfikatorze myorg@@@6Vro7VnjUhpGVn3p
dla usługi API myorg@@@myproduct
:
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
Podsumowanie kodów przyczyn zawieszenia kont deweloperów
W tabeli poniżej znajdziesz kody przyczyn, które wskazują, dlaczego konto dewelopera zostało zawieszone.
Kod przyczyny | Opis |
---|---|
INSUFFICIENT_FUNDS |
Konto dewelopera zostało wyczerpane. |
LIMIT_VIOLATED |
Osiągnięto skonfigurowany limit na koncie dewelopera. |
NO_CURRENT_PUBLISHABLE_ENTITY |
deweloper nie zaakceptował (subskrybuje) cennika; |
RATE_PLAN_RATE_BAND_EXCEEDED |
Osiągnięto skonfigurowany limit ostatniego pasma objętości. |