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

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

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

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

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

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

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

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

Редактирование уведомлений

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

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

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

   Дополнительные сведения о редактировании уведомлений в каждой категории см. в следующих разделах:

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

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

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

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

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

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

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

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

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

Редактирование уведомлений для поставщиков Notify 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.

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

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

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