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

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

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

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

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

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

Страница уведомлений

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

Как изменить уведомления

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

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

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

   Подробную информацию о том, как изменить настройки уведомлений в каждой категории, можно найти в следующих разделах:

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

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

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

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

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

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

Как изменить уведомления, чтобы сообщить о проблеме затронутым разработчикам

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

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

Уведомления об изменении для поставщиков API

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

В таблице ниже перечислены уведомления, основанные на типах событий в разделе Notify API Provider (Поставщик 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_PRODUCTPUBLISHED имеет значение 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), чтобы представлять значения, возвращаемые в объекте Transaction.

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

Как настроить адрес электронной почты для ответов

Для монетизации по умолчанию настроен адрес noreply@apigee.com, который используется для отправки уведомлений компаниям и разработчикам. Чтобы настроить собственное имя и адрес для ответов, обратитесь в службу поддержки Apigee.