Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация
Монетизация предоставляет набор API-интерфейсов, которые можно использовать для возобновления работы разработчика, действие которого было ранее приостановлено, как описано в следующих разделах. Разработчик может быть отстранен от работы, если будет достигнут настроенный предел. Например, количество транзакций достигло максимального предела или баланс предоплаченного счета исчерпан. Полный список кодов причин см. в разделе Сводка кодов причин для приостановленных разработчиков .
Просмотр всех приостановленных разработчиков с помощью API
Просмотрите всех приостановленных разработчиков для организации, отправив запрос GET к следующему ресурсу: /organizations/{org_name}/suspended-developers
.
Где:
-
{org_name}
указывает название организации.
Например, следующий вызов cURL перечисляет всех приостановленных разработчиков myorg
:
curl -H "Content-Type: application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers" \ -u email:password
Ниже приведен пример ответа:
[ { "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" } ]
Просмотр заблокированного разработчика с помощью API
Просмотрите приостановленного разработчика для организации, отправив запрос GET к следующему ресурсу: /organizations/{org_name}/suspended-developers/{developer_email_or_id}
.
Где:
-
{org_name}
указывает название организации. -
{developer_email_or_id}
указывает идентификатор разработчика. Чтобы просмотреть список разработчиков, см. Список разработчиков .
Например, следующий вызов cURL выводит сведения о приостановленном разработчике 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
Ниже приведен пример ответа:
[ { "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" } ]
Возобновление приостановки работы всех разработчиков продукта API, использующего API
Отмените приостановку работы всех разработчиков, которые были заблокированы для продукта API, отправив запрос POST к следующему ресурсу: /organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id}
.
Где:
-
{org_name}
указывает название организации. -
{suspendedProduct_id}
указывает идентификатор продукта API в формате, аналогичном следующему:{org_id}@@@{product_id}
. Это значение возвращается какprodId
при просмотре всех или отдельных приостановленных разработчиков, как описано в разделах Просмотр всех приостановленных разработчиков с помощью API и Просмотр приостановленных разработчиков с помощью API .
Например, следующий вызов cURL отменяет приостановку работы всех разработчиков продукта 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
Возобновление приостановки работы разработчика, использующего API
Отмените приостановку работы конкретного разработчика, отправив запрос DELETE к следующему ресурсу: /organizations/{org_name}/suspended-developers/{suspendedDev_id} .
Где:
-
{org_name}
указывает название организации. -
{suspendedDev_id}
указывает идентификатор приостановленного разработчика в формате, аналогичном следующему:{org_id}@@@{dev_id}
. Это значение возвращается какdevId
при просмотре всех или отдельных приостановленных разработчиков, как описано в разделах Просмотр всех приостановленных разработчиков с помощью API и Просмотр приостановленных разработчиков с помощью API .
При желании вы можете передать следующий параметр запроса:
Параметр запроса | Описание |
---|---|
suspendedProduct_id | Идентификатор продукта API в формате, подобном следующему: {org_id}@@@{product_id} . Это значение возвращается как prodId при просмотре всех или отдельных приостановленных разработчиков, как описано в разделах «Просмотр всех приостановленных разработчиков с помощью API» и «Просмотр приостановленных разработчиков с помощью API» . |
Например, следующий вызов cURL отменяет приостановку работы разработчика с идентификатором myorg@@@6Vro7VnjUhpGVn3p
для продукта 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
Сводка кодов причин для приостановленных разработчиков
В следующей таблице приведены коды причин, указывающие, почему разработчик был заблокирован.
Код причины | Описание |
---|---|
INSUFFICIENT_FUNDS | Аккаунт разработчика исчерпан. |
LIMIT_VIOLATED | Достигнут настроенный лимит для учетной записи разработчика. |
NO_CURRENT_PUBLISHABLE_ENTITY | Разработчик не принял (не подписался) тарифный план. |
RATE_PLAN_RATE_BAND_EXCEEDED | Достигнут настроенный предел конечного диапазона громкости. |