Как применять ограничения монетизации к прокси API

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X.
Информация

Прикрепите правило Monetization Limits Check к прокси API, чтобы обеспечить соблюдение лимитов монетизации. В частности, правила срабатывают при следующих условиях:

  • У разработчика, который обращается к монетизируемому API, нет регистрации или подписки на тарифный план.
  • Разработчик превысил объем транзакций, предусмотренный тарифным планом.
  • Достигнут баланс предоплаченного аккаунта разработчика или кредитный лимит аккаунта с оплатой по факту.

Правила проверки лимитов монетизации предназначены для того, чтобы выявлять ошибки и блокировать вызовы API в ситуациях, подобных перечисленным выше. Это правило расширяет возможности правила "Вызвать ошибку" (см. правило "Вызвать ошибку"), и вы можете настроить возвращаемое сообщение. Условия определяются на основе переменных бизнеса.

Как прикрепить правила проверки ограничений монетизации с помощью интерфейса

Чтобы применить ограничения на монетизацию, к потоку запросов в прокси API, которые обращаются к вашим API, необходимо прикрепить правило проверки ограничений на монетизацию. Правило Monetization Limits Check должно быть прикреплено после любого правила VerifyAPIKey или AccessTokenValidation в запросе.

Вы можете прикрепить правило проверки лимитов монетизации при создании прокси API или после его создания.

Когда вы создаете прокси API, как описано в разделе Создание простого прокси API, если монетизация установлена, в мастере появляется раздел конфигурации монетизации.

Edge

На странице Общие правила мастера установите флажок Применять ограничения монетизации, чтобы прикрепить правило "Проверка ограничений монетизации".

Правила в отношении проверки лимитов монетизации

Обратите внимание, что на странице "Сводка" мастера правила представлены в виде краткого пересказа. Убедитесь, что в списке есть правило монетизации. Это означает, что правило проверки ограничений монетизации будет прикреплено к прокси API, как описано ниже.

Новый интерфейс Edge (частное облако)

  1. Войдите в интерфейс New Edge по адресу http://host:3001/edge, где host – это IP-адрес или DNS-имя хоста, на котором запущен интерфейс New Edge.
  2. На панели навигации слева выберите Develop > API Proxies (Разработка > Прокси API) и нажмите +Proxy (+Прокси), чтобы открыть мастер создания прокси.
  3. На странице Общие правила мастера установите флажок Применять ограничения монетизации, чтобы прикрепить правило "Проверка ограничений монетизации".

    Правила в отношении проверки лимитов монетизации

  4. На странице Summary (Сводка) убедитесь, что в списке есть правило монетизации. Это означает, что правило "Проверка ограничений монетизации" будет прикреплено к прокси API.

Правило Monetization Limits Check добавляется в PreFlow запроса ProxyEndpoint после правила VerifyAPI Key или AccessTokenValidation, как показано на рисунке ниже.

Чтобы добавить политику Monetization Limits Check в уже созданный прокси-сервер API:

  1. В редакторе прокси API нажмите PreFlow для конечной точки прокси по умолчанию.
  2. В окне запроса нажмите +Шаг.
  3. В категории "Медиация" выберите "Проверка ограничений монетизации".

  4. Измените поля в диалоговом окне "Добавить шаг" и нажмите Добавить.

Правило прикрепляется к потоку запросов после любого правила VerifyAPI Key или AccessTokenValidation и применяется к сообщениям запросов от клиентских приложений к PreFlow ProxyEndpoint.

Подробнее о том, как настроить XML-файл правила MonetizationLimitsCheck, можно узнать в статье Правило MonetizationLimitsCheck.