Konfigurowanie powiadomień przy użyciu szablonów powiadomień

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X.
informacje.

Co to są szablony powiadomień?

W ramach funkcji zarabiania dostępny jest zestaw szablonów, które definiują przykładowy tekst dla różnych typów wydarzeń powiadomienia. Możesz dostosować dowolny z tych szablonów, aby:

  • Powiadamianie wszystkich deweloperów o wydarzeniach takich jak nowe usługi lub nowe wersje Warunków korzystania z usługi plany stawek.
  • Powiadom deweloperów, których dotyczy ta zmiana, o wydarzeniach takich jak zmieniony plan opłat.
  • Powiadamianie dostawcy interfejsu API o zdarzeniach związanych z deweloperem, na przykład gdy deweloper się zarejestruje dla konta lub gdy deweloper zarejestruje się w celu skorzystania z abonamentu.
  • powiadamiać wszystkich administratorów firmy o konkretnym wydarzeniu,

Możesz też utworzyć webhooka, który definiuje moduł obsługi wywołania zwrotnego HTTP, a następnie skonfigurować warunek, który aktywuje webhooka, jak opisano w artykule Konfigurowanie powiadomień przy użyciu webhooki.

Poznawanie strony Powiadomienia

Przejdź na stronę Powiadomienia w sposób opisany poniżej.

Edge

Aby uzyskać dostęp do strony powiadomień za pomocą interfejsu Edge:

  1. Zaloguj się na stronie apigee.com/edge.
  2. Kliknij Opublikuj > Zarabianie > Powiadomienia na lewym pasku nawigacyjnym.

Zostanie wyświetlona strona Powiadomienia.

Jak zaznaczono na ilustracji, strona Powiadomienia umożliwia:

Classic Edge (Private Cloud)

Aby uzyskać dostęp do strony Powiadomienia za pomocą interfejsu użytkownika klasycznej wersji Edge:

  1. Zaloguj się w aplikacji http://ms-ip:9000, gdzie ms-ip to adres Adres IP lub nazwa DNS węzła serwera zarządzania.
  2. Wybierz Administracja > powiadomienia na górnym pasku nawigacyjnym.

Strona Powiadomienia umożliwia:

Edytowanie powiadomień

Aby edytować powiadomienie w interfejsie:

  1. Otwórz stronę Powiadomienia.
  2. Kliknij obok powiadomienia, które chcesz edytować, aby rozwinąć jego szczegóły.
  3. Zmodyfikuj pola Temat, Treść i Adresat (jeśli są dostępne) zgodnie z wymaganiami.

    Informacje o zmiennych, które można określić w szablonie powiadomienia, znajdziesz w artykule Używanie zmiennych w szablonach powiadomień.

    Więcej informacji o edytowaniu powiadomień w poszczególnych kategoriach znajdziesz w sekcjach poniżej:

  4. Włącz powiadomienie, zaznaczając znajdujące się obok niego pole wyboru.
  5. Powtórz kroki 2–4, aby edytować dodatkowe powiadomienia.
  6. Aby zapisać wszystkie zmiany, kliknij Zapisz.

Pojawi się komunikat z potwierdzeniem, że powiadomienia zostały zapisane. Operacja zapisu może potrwać kilka minut.

Edytowanie powiadomień w celu powiadomienia wszystkich programistów

Powiadomienia o typach zdarzeń wybranych przez Ciebie w sekcji Powiadom wszystkich deweloperów jest wysyłana do wszystkich programistów.

Powiadomienia są zaplanowane na koniec dnia. Gdy powiadomienia zostaną wysłane, pola wyboru zdarzenia zostaną automatycznie wyczyszczone. Aby je zaplanować, musisz wybrać je ponownie i powiadomieniach dotyczących powiązanych typów zdarzeń.

W tabeli poniżej znajdziesz listę powiadomień według typów zdarzeń w sekcji Powiadom wszystkich deweloperów. Więcej informacji znajdziesz w artykule Edytowanie powiadomień w interfejsie.

Typ zdarzenia Aktywator Uwagi
Nowy pakiet Dostępny jest nowy pakiet interfejsów API

Dodaj nazwę każdego nowego pakietu (oraz produkty zawarte w każdym pakiecie) do pola szablonu e-maila. Możesz też dodać link do portalu dla deweloperów ani w innej witrynie, która zawiera więcej informacji na temat powiadomienia.

Nowy produkt Dostępna jest nowa usługa API

Dodaj nazwę każdego nowego produktu do treści szablonu e-maila. . Możesz też dodać link do portalu dla deweloperów lub innej witryny, która zawiera więcej informacji o powiadomieniu.

Nowe rynki/zasięg Nowe usługi API są dostępne na określonych rynkach geograficznych

Dodaj do treści e-maila nazwę każdego nowego rynku i odpowiednich produktów. szablon. Możesz też dodać link do portalu dla deweloperów lub dowolnego inna witryna, która zawiera więcej informacji o powiadomieniu.

Edytowanie powiadomień w celu powiadomienia deweloperów, których dotyczy problem

Powiadomienia dotyczące typów zdarzeń wybranych w sekcji Powiadom, których dotyczy problem Sekcja Dla deweloperów jest wysyłana tylko do deweloperów, których dotyczą te typy zdarzeń. Jeśli na przykład wybierzesz zdarzenie Zmieniony plan stawek, powiadomienie zostanie wysłane tylko do tych osób deweloperów, którzy zaakceptowali taki abonament.

W tabeli poniżej znajdziesz listę powiadomień posortowanych według typów zdarzeń w sekcji Powiadom deweloperów, których dotyczy problem. Więcej informacji znajdziesz w artykule Edytowanie powiadomień w interfejsie.

Typ zdarzenia Aktywator Uwagi
Warunki nie zostały zaakceptowane lub straciły ważność Nowe warunki zostały opublikowane, a deweloper jeszcze ich nie zaakceptował.

Powiadomienie jest wysyłane na 30 dni, 7 dni oraz 1 dzień przed datą wprowadzenia nowych Warunków korzystania z usługi. wejścia w życie.

Nowy plan stawek Opublikowano nowe plany stawek

Jeśli plan stawek to:

  • Abonament standardowy – wszyscy deweloperzy otrzymują powiadomienia.
  • Plan stawek dla kategorii dewelopera. Powiadomienia otrzymują tylko deweloperzy w tej kategorii.
  • planu stawek dla deweloperów, powiadamiamy o nich tylko konkretnego dewelopera.
Skorygowany plan taryf Dostępna jest nowsza wersja zakupionego abonamentu

Powiadomimy o tym tylko tych deweloperów, którzy kupili bieżącą wersję. pozwala deweloperom zapoznać się z nową wersją i zakończyć działanie lub przełączyć , jeśli nie chcą zaakceptować nowych stawek.

Wygasły abonament Abonament wygasł bez dodatkowego planu

To powiadomienie jest wysyłane, gdy pierwszy raz ustawisz wygaśnięcie abonamentu. dodatkowe powiadomienia wysłane na 30, 7 i 1 dzień przed upływem daty ważności. Tylko wybrane deweloperzy, którzy kupili abonament, aby wygasną, otrzymają powiadomienie.

Odnowiony abonament Subskrypcja abonamentu została odnowiona.

Poinformuj dewelopera, że zostaną naliczone obowiązujące opłaty.

Przekroczono limit liczby żądań Przekroczono limit abonamentu

Poinformuj dewelopera, że zostaną naliczone obowiązujące opłaty.

Abonament Freemium ze zużyciem Okresy bezpłatnego użytkowania mierzone za pomocą liczby transakcji lub dni zostały wyczerpane

Okres bezpłatnego użytkowania jest określany przez abonament freemium.

Opublikowano dokument rozliczeniowy

Dostępne są dokumenty rozliczeniowe (np. faktury) dewelopera.

Deweloper rejestruje się w ramach nowego abonamentu Deweloper rejestruje się, aby uzyskać nowy abonament.

Edytowanie powiadomień dotyczących powiadamiania dostawców interfejsu API

Powiadomienia o typach zdarzeń wybranych w sekcji Notify API Provider (Powiadom dostawcę interfejsu API) jest wysyłana do podanego dostawcy interfejsu API.

Tabela poniżej zawiera listę powiadomień opartych na typach zdarzeń w sekcji Powiadom dostawcy interfejsu API. Więcej informacji znajdziesz w artykule Edytowanie powiadomień w interfejsie.

Typ zdarzenia Aktywator
Rejestracja nowego programisty

Deweloper zarejestrował konto.

Deweloper dodaje aplikację

Programista utworzył nową aplikację.

Rejestracja dewelopera i nowy abonament

Deweloper zarejestrował plan stawek.

Deweloper zmienia szczegóły finansowe

Deweloper zmienił dane finansowe, takie jak nazwa lub firma. adresu.

Włączanie i wyłączanie powiadomień

Aby włączyć lub wyłączyć powiadomienia za pomocą interfejsu:

  1. Otwórz stronę Powiadomienia.
  2. Włącz lub wyłącz powiadomienie, zaznaczając lub odznaczając znajdujące się obok niego pole wyboru.
  3. Aby zapisać wszystkie zmiany, kliknij Zapisz.

Operacja zapisu może potrwać kilka minut. Pojawi się komunikat z potwierdzeniem, że powiadomienia zostały zapisane.

Konfigurowanie powiadomień za pomocą szablonów w interfejsie API

Powiadomienia możesz skonfigurować przy użyciu interfejsu API w sposób opisany w sekcjach poniżej.

Zarządzanie szablonami powiadomień za pomocą interfejsu API

Szablonami powiadomień możesz zarządzać za pomocą interfejsu API w sposób opisany w tych sekcjach:

Wyświetlanie wszystkich szablonów powiadomień korzystających z interfejsu API

Możesz wyświetlić listę wszystkich szablonów powiadomień dostępnych w ramach funkcji zarabiania, uruchamiając polecenie GET żądanie do /mint/organizations/{org_name}/notification-email-templates. Na przykład:

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

Ten przykładowy szablon zdarzenia powiadamia deweloperów o dostępności nowej usługi 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
}

Wyświetlanie szablonu powiadomienia przy użyciu interfejsu API

Wyświetl szablon powiadomienia, wysyłając żądanie GET do /mint/organizations/{org_name}/notification-email-templates/{template_id}, gdzie {template_id} to identyfikator szablonu. Na przykład:

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

Elementy w szablonach, które zaczynają się od znaku $, są zmiennymi. Więcej informacji znajdziesz w artykule Używanie zmiennych w szablonach powiadomień. Załóżmy, że zmienne w parametrze przyjmują następujące wartości:

  • ${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

Komunikat z powiadomieniem pochodzący z szablonu:

    "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"

Edytowanie szablonu powiadomień za pomocą interfejsu API

Edytuj szablon powiadomienia, wysyłając żądanie PUT do /nint/organizations/{org_name}/notification-email-templates/{template_id} Podaj zmienioną zawartość szablonu w treści żądania.

Gdy dostosowujesz wiadomość w szablonie powiadomienia, możesz umieścić w niej zmiennych. Aby uzyskać więcej informacji, zapoznaj się z sekcją Używanie zmiennej w powiadomieniu .

Na przykład to żądanie edytuje treść powiadomienia o nowym interfejsie 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

Zarządzanie warunkami i działaniami dotyczącymi powiadomień przy użyciu interfejsu API

Zarządzaj warunkami i działaniami dotyczącymi powiadomień za pomocą API zgodnie z opisem w kolejnych sekcjach.

Tworzenie warunku powiadomień i działania przy użyciu interfejsu API

Utwórz warunek powiadomienia i działanie, które spowoduje wysłanie automatycznego powiadomienia żądanie POST do /mint/organizations/{org_name}/notification-conditions.

Wysyłając żądanie, określ w treści żądania warunek, który prowadzi do wywołania oraz działań, jakie należy podjąć w przypadku spełnienia warunku (takie jak wysłanie e-maila z powiadomieniem).

Aby zdefiniować szczegóły warunku powiadamiania, określ co najmniej jeden atrybut . Listę właściwości znajdziesz w sekcji Właściwości konfiguracji dotyczące warunków powiadamiania. atrybutów. W przypadku powiadomienia o zdarzeniu warunek może być aktywowany, gdy nowy produkt zostanie opublikowano.

Podczas określania właściwości actions korzystaj z odpowiedniego szablonu powiadomienia. Zobacz Listę działań znajdziesz w sekcji Właściwości konfiguracji działań związanych z powiadomieniami.

Na przykład to żądanie określa, że atrybut to NEW_PRODUCT, a wartość atrybutu PUBLISHED to true, wyślij powiadomienie z identyfikatorem w szablonie 01191bf9-5fdd-45bf-8130-3f024694e63 (to jest 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

Wyświetlanie warunku powiadomienia i działania przy użyciu interfejsu API

Wyświetl warunek powiadomienia i działanie, wysyłając żądanie GET do organizations/{org_name}/notification-conditions/{condition_Id}, gdzie {condition_Id} to identyfikator warunku. Identyfikator jest zwracany po utworzeniu warunek powiadomienia. Na przykład:

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

Oto przykład takiej odpowiedzi:

    {
    "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"
    } ]
    }

Edytowanie warunku powiadomienia i działania za pomocą interfejsu API

Edytuj warunek powiadomienia i działanie, wysyłając żądanie POST do organizations/{org_name}/notification-conditions/{condition_Id}, gdzie {condition_Id} to identyfikator warunku. Identyfikator jest zwracany po utworzeniu warunku powiadamiania. Przy wysyłaniu żądania określ w treści żądania zmiany, które które chcesz zastosować w warunku lub działaniu powiadomienia.

Na przykład:

   $ 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

Usuwanie warunku powiadomień i działania przy użyciu interfejsu API

Usuń warunek powiadomienia, wysyłając żądanie DELETE do organizations/{org_name}notification-conditions/{condition_Id} Na przykład:

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

Właściwości konfiguracji warunków powiadamiania

Podczas korzystania z interfejsu API dostępne są poniższe właściwości konfiguracji warunków powiadamiania.

Nazwa Opis Domyślny Wymagana?
attribute

Szczegóły warunku powiadamiania. Możesz podać jeden lub więcej atrybutów, aby doprecyzować warunek powiadamiania.

Możliwe wartości:

  • ADD_RATEPLAN
  • ADHOC_NOTIFY_DEVELOPERS
  • BILLING_DOCS_PUBLISHED
  • COMPANY_ACCEPTS_INVITATION
  • COMPANY_CANCELS_INVITATION
  • COMPANY_DECLINES_INVITATION
  • COMPANY_INVITES_DEVELOPER
  • CREATE_APPLICATION
  • CREATE_DEVELOPER
  • DATE
  • DEVELOPER_ACCEPTS_INVITATION
  • DEVELOPER_CANCELS_INVITATION
  • DEVELOPER_DECLINES_INVITATION
  • DEVELOPER_INVITES_COMPANY
  • EXPIRING_TNC
  • FeeExposure
  • FREEMIUM_USED_UP
  • NEW_PACKAGE
  • NEW_PRODUCT
  • PUBLISHED
  • RATEPLAN
  • RATEPLAN_ACCEPTED
  • RATEPLAN_ENDED
  • RATEPLAN_EXPIRED
  • RATEPLAN_RENEWED
  • RATEPLAN_REVISION
  • Transactions
  • UPDATE_DEVELOPER
  • UsageTarget (ważne do konfigurowania tylko webhooki)
Nie dotyczy Tak
value

Wartość atrybutu.

Nie dotyczy Nie
associatedCondition

Odniesienie do powiązanego warunku.

Nie dotyczy Nie

Właściwości konfiguracji działań związanych z powiadomieniami

Poniższe właściwości konfiguracji są dostępne w przypadku działań związanych z powiadomieniami podczas korzystania z interfejsu API.

Nazwa Opis Domyślny Wymagana?
actionAttribute

Metoda używana do identyfikacji odbiorcy powiadomienia. Wartością może być jedna lub więcej wartości: następujące:

  • ORG_EMAIL Odbiorca powiadomień jest identyfikowany na podstawie adresu e-mail.
  • DEV_ID Odbiorca powiadomień jest identyfikowany na podstawie identyfikatora dewelopera (adresu e-mail).
  • COMPANY_ADMINS Powiadomienie jest wysyłane do wszystkich administratorów firmy niezależnie od ustawionej wartości. Pamiętaj, że administratorzy w firmie to nie to samo co administratorów organizacji.
  • WEBHOOK Informacje o odbiorcy powiadomień są wysyłane do webhooka do obsługi wywołania zwrotnego. Zobacz Konfigurowanie powiadomień przy użyciu webhooków.
Nie dotyczy Tak
value

Wartość atrybutu działania.

Jeśli actionAttribute ma wartość ORG_EMAIL lub DEV_ID, wartość ANY powoduje wysłanie powiadomienia do wszystkich odpowiednich odbiorcy, na przykład dowolny adres ORG_EMAIL lub dowolny DEV_ID

Jeśli actionAttribute ma wartość WEBHOOK, ustaw tę wartość na Identyfikator webhooka.

Jeśli actionAttribute ma wartość COMPANY_ADMINS, ta wartość jest ignorowana. Wysłano powiadomienie do wszystkich administratorów w firmie.

Nie dotyczy Tak
templateID

Identyfikator szablonu powiadomienia.

Uwaga: ta opcja jest nieprawidłowa, jeśli ustawiono actionAttribute do WEBHOOK.

Nie dotyczy Tak
postURL

Moduł obsługi wywołania zwrotnego dla webhooka.

Uwaga: ta opcja jest wymagana, jeśli ustawiono actionAttribute do WEBHOOK. Ta opcja jest nieprawidłowa, jeśli wartość jest ustawiona na ORG_EMAIL, DEV_ID lub COMPANY_ADMINS.

Nie dotyczy Tak

Używanie zmiennych w szablonach powiadomień

Gdy edytujesz wiadomość w szablonie powiadomienia, możesz dodać jedną lub wiele zmiennych. za pomocą języka Spring Expression Language (SpEL) do reprezentowania wartości zwracanych w transakcji. obiektu.

W tabeli poniżej znajdziesz podsumowanie najczęściej używanych zmiennych szablonu powiadomień.

Zmienna Opis
${application.name}

Nazwa aplikacji.

${application.products.name} Nazwa usługi uwzględnionej w aplikacji.
${BALANCE} Saldo danego limitu.
${developer.legalName}

Nazwa firmy dewelopera.

${developer.name}

Nazwa dewelopera.

${EXPIRY_DATE}

Data lub godzina, kiedy limit wygaśnie lub zostanie zresetowany.

${LONG_PERCENT} Odsetek osiągniętego limitu przez bieżące wykorzystanie, bez symbolu %. Na przykład 50
${PERCENT}

Procent osiągniętego przez bieżące wykorzystanie, wyrażony jako % symboli. np. 50%.

${products.displayName} Wyświetlana nazwa zdefiniowana dla produktu.
${QUOTA_TYPE}

Typ limitu (liczba transakcji, limit wydatków lub ekspozycja opłat).

${QUOTA_UNIT}

Podstawowa jednostka związana z limitem: waluta (w przypadku limitu wydatków) lub połączenia (w przypadku transakcji) (limit).

${QUOTA_LIMIT}

Kwota limitu.

${ratePlan.displayName} Wyświetlana nazwa zdefiniowana dla planu stawek.
${ratePlan.endDate} Data zakończenia abonamentu przez dostawcę interfejsu API.
${ratePlan.monetizationPackage.displayName}

Nazwa pakietu interfejsów API.

${ratePlan.monetizationPackage.name} Nazwa pakietu do zarabiania.
${ratePlan.monetizationPackage.products.displayName}

Wyświetlana nazwa zdefiniowana dla usługi API.

${ratePlan.monetizationPackage.products.name} Nazwa produktu w pakiecie do zarabiania.
${ratePlan.startDate} Data utworzenia planu stawek.
${USAGE} Bieżące wykorzystanie (łączne przychody lub opłaty lub wielkość sprzedaży).
${USER}

Nazwa użytkownika.