Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info
Монетизация предоставляет набор 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 разблокирует разработчика с ID 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 | Достигнут заданный предел диапазона конечной громкости. |
Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info
Монетизация предоставляет набор 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 разблокирует разработчика с ID 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 | Достигнут заданный предел диапазона конечной громкости. |