Настройка уведомлений с помощью шаблонов уведомлений

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

Что такое шаблоны уведомлений?

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

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

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

Изучение страницы уведомлений

Перейдите на страницу уведомлений, как описано ниже.

Уведомления о редактировании

Чтобы отредактировать уведомление с помощью пользовательского интерфейса:

1. Перейдите на страницу уведомлений .
2. Нажмите Рядом с уведомлением, которое вы хотите отредактировать, разверните его подробности.
3. При необходимости отредактируйте поля «Тема», «Текст» и «Получатель» (если имеется).

   Информацию о переменных, которые можно указать в шаблоне уведомления, см. в разделе «Использование переменных в шаблонах уведомлений» .

   Для получения более подробной информации о редактировании уведомлений в каждой категории обратитесь к следующим разделам:

   • Редактирование уведомлений для оповещения всех разработчиков.
   • Редактирование уведомлений для оповещения затронутых разработчиков.
   • Редактирование уведомлений для оповещения поставщиков API.
4. Включите уведомление, установив флажок рядом с ним.
5. Повторите шаги 2–4, чтобы отредактировать дополнительные уведомления.
6. Нажмите «Сохранить» , чтобы сохранить все изменения.

Отобразится сообщение, подтверждающее сохранение уведомлений. Сохранение может занять несколько минут.

Редактирование уведомлений для оповещения всех разработчиков.

Уведомления о выбранных вами типах событий в разделе «Уведомлять всех разработчиков» отправляются всем разработчикам.

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

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

Редактирование уведомлений для оповещения затронутых разработчиков.

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

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

Редактирование уведомлений для оповещения поставщиков API.

Уведомления о событиях выбранного вами типа в разделе «Уведомлять поставщика API» отправляются указанному вами поставщику API.

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

Включение или отключение уведомления

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

1. Перейдите на страницу уведомлений .
2. Чтобы включить или отключить уведомление, установите или снимите флажок рядом с ним.
3. Нажмите «Сохранить» , чтобы сохранить все изменения.

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

Настройка уведомлений с использованием шаблонов через API.

Настройте уведомления с помощью API, как описано в следующих разделах.

Управление шаблонами уведомлений с помощью API

Управление шаблонами уведомлений осуществляется с помощью API, как описано в следующих разделах:

• Просмотр всех шаблонов уведомлений с помощью API
• Просмотр шаблона уведомления с помощью API
• Редактирование шаблона уведомления с помощью API

Просмотр всех шаблонов уведомлений с помощью API

Вы можете получить список всех шаблонов уведомлений, предоставляемых монетизацией, отправив GET-запрос по адресу /mint/organizations/{org_name}/notification-email-templates . Например:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \
  -u email:password

Например, ниже представлен шаблон события, который уведомляет разработчиков о доступности нового API-продукта:

{
    "createdDate" : 1376975394984,
    "htmlImage" : "<p>Dear ${developer.legalName} , ${developer.name} <br /> Introducing _________. For more details visit us at _________________</p>",
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "name" : "DEFAULT_NEW_PRODUCT_TEMPLATE",
    "orgId" : "myorg",
    "source" : "Mail Man Test",
    "subject" : "Notification of new product",
    "updatedDate" : 1376975394984
}

Просмотр шаблона уведомления с помощью API

Чтобы просмотреть шаблон уведомления, отправьте GET-запрос по адресу /mint/organizations/{org_name}/notification-email-templates/{template_id} , где {template_id} — это идентификатор шаблона. Например:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b" \
  -H "Accept:application/json"  \
  -u email:password

Элементы в шаблонах, начинающиеся с символа $, являются переменными. Дополнительную информацию см. в разделе «Использование переменных в шаблонах уведомлений» . Предположим, что переменные в уведомлении принимают следующие значения:

• ${developer.legalName}.XYZ company
• ${developer.name}.DEV1
• ${QUOTA_TYPE}.Transactions
• ${PERCENT}.90%
• ${QUOTA_UNIT}.Calls
• ${QUOTA_LIMIT}.100
• ${ratePlan.monetizationPackage.products.name}.X
• ${EXPIRY_DATE}.2016-09-30

Уведомление, предоставляемое шаблоном, будет выглядеть следующим образом:

    "Dear XYZ company, DEV1
    You have exceeded Transactions of 90% calls of 100 calls for X product. Your API calls will be blocked till 2016-09-30"

Редактирование шаблона уведомления с помощью API

Отредактируйте шаблон уведомления, отправив PUT-запрос по адресу /nint/organizations/{org_name}/notification-email-templates/{template_id} . Укажите измененное содержимое шаблона в теле запроса.

При настройке сообщения в шаблоне уведомления можно использовать одну или несколько переменных. Дополнительную информацию см. в разделе «Использование переменных в шаблонах уведомлений» .

Например, следующий запрос изменяет содержимое уведомления о новом продукте API:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b " \
  -H "Content-Type: application/json" \
  -d '{
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "htmlImage" : "<p>Exciting news, we have added a new product :${Product.name}. See details in <a href="${Product.url}">New Products</a> </p>",
    "name" : "NewProductNotification",
    "organization": {
    "id": "{org_name}"
    },
    "source" : "Mail Man Test ",
    "subject" : "New Product Available: ${Product.name}"
  }' \
  -u email:password

Управление условиями и действиями уведомлений с помощью API.

Управляйте условиями и действиями уведомлений с помощью API, как описано в следующих разделах.

• Создание условия уведомления и действия с помощью API
• Просмотр условий уведомления и действий с помощью API.
• Редактирование условия уведомления и действия с помощью API.
• Удаление условия уведомления и действия с помощью API.

Создание условия уведомления и действия с помощью API

Создайте условие и действие для уведомления, которые приведут к автоматическому уведомлению, отправив POST-запрос на /mint/organizations/{org_name}/notification-conditions .

При отправке запроса укажите в теле запроса условие, которое приводит к уведомлению, и действия, которые должны быть предприняты при достижении этого условия (например, отправка уведомления по электронной почте).

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

При определении actions используйте соответствующий шаблон уведомления. Список действий см. в разделе «Свойства конфигурации действий уведомления» .

Например, следующий запрос указывает, что если атрибут имеет значение NEW_PRODUCT , а значение атрибута PUBLISHED равно true , то необходимо отправить уведомление в шаблоне с идентификатором 01191bf9-5fdd-45bf-8130-3f024694e63 (это DEFAULT_NEW_PRODUCT_TEMPLATE ).

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
  -H "Content-Type:application/json"
  -d '{
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
      "attribute": "PUBLISHED",
      "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
  }' \
  -u email:password

Просмотр условий уведомления и действий с помощью API.

Чтобы просмотреть условие уведомления и действие, отправьте GET-запрос по адресу organizations/{org_name}/notification-conditions/{condition_Id} , где {condition_Id} — это идентификатор условия. Идентификатор возвращается при создании условия уведомления. Например:

curl -X GET "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -H "Accept:application/json" \
  -u email:password

Ниже приведён пример ответа:

    {
    "actions" : [ {
    "actionAttribute" : "DEV_ID",
    "id" : "141ba00c-d7bd-4fef-b339-9d58b83255f4",
    "templateId" : "766aba4f-0f7a-4555-b48e-d707c48b8f4c",
    "value" : "ANY"
    }, {
    "actionAttribute" : "ORG_EMAIL",
    "id" : "21486ce1-4290-4a55-b415-165af3e93c9d",
    "templateId" : "efa4ce63-7c08-4876-984b-6878ec435994",
    "value" : "DEFAULT_LIMIT_NOTIFICATION_EMAIL"
    } ],
    "notificationCondition" : [ {
    "attribute" : "Balance",
    "id" : "2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4",
    "organization" : {
    ...
    },
    "value" : "< 0"
    } ]
    }

Редактирование условия уведомления и действия с помощью API.

Чтобы изменить условие и действие уведомления, отправьте POST-запрос по адресу organizations/{org_name}/notification-conditions/{condition_Id} , где {condition_Id} — это идентификатор условия. Идентификатор возвращается при создании условия уведомления. При отправке запроса укажите в теле запроса изменения, которые вы хотите внести в условие или действие уведомления.

Например:

   $ curl -H "Content-Type:application/json" -X POST -d \
    ' {
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
    "attribute": "PUBLISHED",
    "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
    }' \
    "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -u email:password

Удаление условия уведомления и действия с помощью API.

Удалите условие уведомления, отправив запрос DELETE по адресу organizations/{org_name}notification-conditions/{condition_Id} . Например:

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4"  \
  -H "Accept:application/json"  \
  -u email:password

Свойства конфигурации для условий уведомления

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

Свойства конфигурации для действий уведомлений

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

Использование переменных в шаблонах уведомлений

При редактировании сообщения в шаблоне уведомления можно использовать одну или несколько переменных, представляющих значения, возвращаемые объектом Transaction, с помощью языка выражений Spring Expression Language (SpEL).

В таблице ниже приведено краткое описание наиболее часто используемых переменных шаблона уведомлений.