Настройка уведомлений об лимитах

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

Введение

Вы можете установить ограничения, связанные с монетизацией, как описано в разделе «Обеспечение соблюдения ограничений монетизации с помощью политики проверки ограничений монетизации» . Вы также можете настроить автоматические уведомления, которые будут оповещать разработчиков и/или пользователей в вашей организации о приближении к лимиту или его достижении.

Вы можете настроить автоматические уведомления как для пользовательских, так и для неявных лимитов. Например, система устанавливает неявный лимит для ваших разработчиков, использующих предоплаченные тарифы, — это их баланс предоплаченных услуг. Вы можете настроить автоматические уведомления, чтобы ваши разработчики получали оповещения, если они приближаются к своему лимиту предоплаченных услуг или уже достигли его.

Ящик с инструментами

Вы можете настроить автоматические уведомления об ограничениях, используя пользовательский интерфейс управления или API монетизации. При использовании пользовательского интерфейса автоматические уведомления настраиваются на странице «Уведомления».

При использовании API вы настраиваете автоматические уведомления об ограничениях, редактируя шаблон уведомления, предоставляемый системой монетизации. Затем вы указываете условие, которое приводит к отправке уведомления, предоставленного отредактированным шаблоном.

Настройка уведомлений об ограничении с помощью пользовательского интерфейса.

  1. На странице добавления лимита в разделе «Уведомления» нажмите кнопку «Добавить». Откроется раздел «Уведомления».

  2. Выберите уровень уведомления. Это может быть пороговое значение, основанное на абсолютном числе или на проценте от установленного лимита. Выберите:
    • Выберите знак «больше или равно» (?) или знак «меньше или равно» (?) из выпадающего меню.
    • Целое число (то есть без десятичных знаков). Абсолютное значение (для обозначения числового значения) или процентное значение (для обозначения процентного значения). Для процентных ограничений всегда устанавливайте значение >, это означает, что уведомление отправляется, когда разработчик достигает или превышает этот процентный уровень.

    Например, если вы установите лимит расходов в 100 долларов и укажете время отправки уведомления — когда лимит будет достигнут или превышен (90% от лимита, то уведомление будет отправлено, когда он достигнет или превысит 90%).

  3. В поле «Отправить электронное письмо» выберите одного или нескольких разработчиков или одного или нескольких пользователей в вашей организации. Уведомление будет отправлено соответствующим разработчикам или пользователям.

    Получатели электронных писем: Вы можете отправлять уведомления разработчикам только в том случае, если установите условие ограничения количества разработчиков «Любой» или установите условие ограничения количества разработчиков для конкретного разработчика. Если вы выбрали «Любой», в списке адресов электронной почты вы увидите «Выбранный разработчик (Любой)». Это означает, что система монетизации отправит уведомление всем затронутым разработчикам. Если вы выбрали конкретного разработчика, в списке адресов электронной почты вы увидите «Выбранный разработчик ( {developer_id} )» (где {developer_id} — идентификатор выбранного разработчика). Система монетизации отправит уведомление только этому конкретному разработчику.

    Если вы не выбрали условие ограничения количества разработчиков «Любой» или не указали конкретного разработчика, в поле «Отправить электронное письмо» не отобразится «Выбранный разработчик (Любой)». Однако вы можете выбрать, каких пользователей вашей организации вы хотите уведомить.

    Добавить адреса электронной почты пользователей вашей организации можно, выбрав «Пользователи организации» на вкладке «Администрирование».

    Шаблоны электронных писем: После выбора в поле «Отправить письмо» параметра «Выбранный разработчик (любой)» или адресов электронной почты пользователей вашей организации (или и того, и другого) вы увидите шаблон электронного письма. Содержимое шаблона зависит от следующих факторов:

    • Уровень уведомления.
    • Было ли это ограничение ограничением на остановку выполнения.
    • Независимо от того, предназначалось ли электронное письмо для пользователей организации, разработчиков или для обеих групп.

    Например, если выполняются все следующие условия:

    • Флажок «Остановить выполнение» установлен.
    • Уровень уведомления составляет 100% или равен установленному лимиту.
    • Этот адрес электронной почты предназначен только для пользователей организации.

    Шаблон выглядит следующим образом:

    Предположим, что название компании разработчика — «Компания XYZ», лимит объема транзакций установлен на уровне 50 для пакета API с именем «Пакет X» и продукта API с именем «Продукт Y», а срок действия установлен на 30 сентября 2013 года. Отправляемое электронное письмо будет выглядеть следующим образом:

    Developer XYZ company has exceeded their transaction volume limit of 50 transactions for X package, Y product. Their API calls will be blocked till 2013-09-30

    Если электронное письмо адресовано «Выбранному разработчику (любому)», шаблон будет выглядеть следующим образом:

    Оба шаблона обработают соответствующие переменные, такие как имя разработчика (если применимо), имя пакета (если применимо) и название продукта (если применимо). Вы можете отредактировать сообщение в соответствии со своими требованиями, нажав кнопку «Редактировать» слева от шаблона.

    Если ограничение распространяется на «Любое» приложение и «Любое» приложение и конкретного пользователя, вам также необходимо добавить в шаблон переменные для приложения(й) и пользователя(ей). Это можно сделать следующим образом:

    • Нажмите кнопку «Редактировать» слева от шаблона.
    • Добавьте ${user.name} user, depending on whether the limit is for application and/or user.

    Ниже представлен шаблон, отредактированный для "любого" или конкретного приложения.

    Если флажок «Остановить выполнение» не установлен, или уровень уведомления равен или превышает 100%, шаблон для выбранного разработчика будет выглядеть следующим образом:

    Опять же, если ограничение распространяется на «Любое» (или конкретное) приложение или на «Любого» (или конкретного) пользователя, вам необходимо отредактировать шаблон и добавить приложение ${application.name} и/или пользователя ${user.name} в зависимости от того, распространяется ли ограничение на приложение, пользователя или на оба.

    Переменные шаблона: При редактировании сообщения в шаблоне электронного письма вы можете включить любую из следующих переменных.

    Переменная Описание
    ${developer.name}

    Имя разработчика.

    ${developer.legalName}

    Название компании-разработчика.

    ${ratePlan.monetizationPackage.displayName}

    Название пакета API.

    ${application.name}

    Название приложения.

    ${USER}

    Имя пользователя.

    ${USAGE}

    Текущее использование (общий доход или платежи, или объем).

    ${PERCENT}

    Процент от лимита, достигнутый текущим использованием.

    ${QUOTA_TYPE}

    Тип ограничения (объем транзакций, лимит расходов или размер комиссионных сборов).

    ${QUOTA_UNIT}

    Основная единица измерения лимита: валюта (для лимита расходов) или звонки (для лимита транзакций).

    ${QUOTA_LIMIT}

    Величина лимита.

    ${EXPIRY_DATE}

    Дата или время истечения срока действия лимита или его сброса.

    Например, если вы хотите получать уведомления о достижении разработчиком определенного процента объема транзакций для любого пакета в любом приложении, вы можете отредактировать шаблон следующим образом:

    ${developer.legalName} has reached a total volume of ${USAGE} on ${ratePlan.monetizationPackage.displayName}. This is ${PERCENT} of the daily/weekly/monthly (state period of limit as appropriate) transaction volume limit of ${QUOTA_LIMIT}.
  4. При необходимости добавьте уведомления для дополнительных уровней. Для каждого дополнительного уровня нажмите «Добавить». Это добавит в раздел «Уведомления» области «Уровень», «Отправить электронное письмо» и «Шаблон электронного письма». Вы можете добавить до 6 уровней для своих уведомлений. Например, если вы установите уровень уведомления > 70%, 80%, 90%, 100%, то уведомление будет отправлено при достижении каждого из этих уровней.
  5. После добавления всех уведомлений нажмите «Сохранить» (чтобы сохранить и опубликовать уведомления позже), «Сохранить и опубликовать» (чтобы опубликовать сейчас) или «Отменить» (чтобы отменить).

Настройка уведомлений об ограничениях с помощью API

Монетизация предоставляет набор шаблонов, содержащих текст для различных типов уведомлений, включая уведомления об ограничениях, а также произвольные уведомления, например, оповещения разработчиков о доступности новых продуктов. Вы можете настроить любой из этих шаблонов в соответствии со своими потребностями. Чтобы настроить автоматическое уведомление об ограничении, сначала отредактируйте соответствующий шаблон. Затем укажите условие, которое приведет к отправке уведомления, предоставленное отредактированным шаблоном. Дополнительные сведения см. в разделе «Настройка уведомлений с помощью шаблонов уведомлений» .

Следующие шаги

Узнайте, как настроить автоматические уведомления, чтобы оповещать разработчиков о таких событиях, как новые продукты, новые версии условий использования или новые тарифные планы. См. раздел «Настройка уведомлений с помощью шаблонов уведомлений» .