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

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Czym są szablony powiadomień?

Funkcja zarabiania udostępnia zestaw szablonów, które definiują przykładowy tekst różnych typów powiadomień o zdarzeniach. Możesz dostosować każdy z tych szablonów, aby:

  • Powiadamiaj wszystkich deweloperów o wydarzeniach takich jak nowe produkty, nowe wersje warunków lub nowe abonamenty.
  • Powiadamiaj deweloperów, których dotyczy ta kwestia, o wydarzeniach takich jak zmieniony plan taryfowy.
  • Powiadamiaj dostawcę interfejsu API o zdarzeniach związanych z deweloperem, takich jak rejestracja konta przez dewelopera lub rejestracja w abonamencie taryfowym.
  • powiadamia wszystkich administratorów w firmie o określonym wydarzeniu;

Możesz też utworzyć webhooka, który definiuje moduł obsługi wywołania zwrotnego HTTP, a następnie skonfigurować warunek wywołujący webhooka zgodnie z opisem w sekcji Konfigurowanie powiadomień przy użyciu webhooków.

Poznawanie strony Powiadomienia

Otwórz stronę Powiadomienia w sposób opisany poniżej.

Edge

Aby uzyskać dostęp do strony Powiadomienia przy użyciu interfejsu Edge:

  1. Zaloguj się na stronie apigee.com/edge.
  2. Na pasku nawigacyjnym po lewej stronie wybierz Opublikuj > Zarabianie > Powiadomienia.

Wyświetli się strona Powiadomienia.

Jak zaznaczyliśmy na ilustracji, strona Powiadomienia umożliwia:

Klasyczna wersja Edge (Private Cloud)

Aby uzyskać dostęp do strony Powiadomienia w klasycznym interfejsie użytkownika Edge:

  1. Zaloguj się w http://ms-ip:9000, gdzie ms-ip to adres IP lub nazwa DNS węzła serwera zarządzania.

  2. Wybierz Administracja > Powiadomienia na górnym pasku nawigacyjnym.

Na stronie Powiadomienia możesz:

Edytowanie powiadomień

Aby edytować powiadomienie za pomocą interfejsu:

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

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

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

  4. Włącz powiadomienie, zaznaczając pole wyboru obok niego.
  5. Aby edytować dodatkowe powiadomienia, powtórz kroki 2–4.
  6. Kliknij Zapisz, aby zapisać wszystkie zmiany.

Wyświetli się komunikat potwierdzający zapisanie powiadomień. Zapisywanie może potrwać kilka minut.

Edytowanie powiadomień w celu powiadomienia wszystkich deweloperów

Powiadomienia o typach zdarzeń wybranych w sekcji Powiadom wszystkich deweloperów są wysyłane do wszystkich deweloperów.

Powiadomienia są wysyłane pod koniec dnia. Po wysłaniu powiadomień pola wyboru zdarzeń są automatycznie czyszczone. Aby zaplanować powiadomienia dotyczące powiązanych typów zdarzeń, musisz wybrać je ponownie.

Tabela poniżej zawiera listę powiadomień według typów zdarzeń w sekcji Powiadom wszystkich deweloperów. Więcej informacji znajdziesz w artykule Edytowanie powiadomień przy użyciu interfejsu użytkownika.

Typ zdarzenia Aktywator Uwagi
Nowy pakiet Dostępny jest nowy pakiet interfejsu API

W ramach aktualizacji dodaj nazwę każdego nowego pakietu (i produktów w nim zawartych) 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.
Nowy produkt Dostępna jest nowa usługa API

W ramach aktualizacji dodaj nazwę każdej nowej usługi w 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 i zasięg Nowe usługi API są dostępne na określonych rynkach geograficznych

W ramach aktualizacji dodaj w treści szablonu e-maila nazwy każdego nowego rynku i odpowiednich produktów. Możesz też dodać link do portalu dla deweloperów lub innej witryny, która zawiera więcej informacji o powiadomieniu.

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

Powiadomienia o typach zdarzeń wybranych w sekcji Powiadom deweloperów, których dotyczy problem, są wysyłane tylko do deweloperów, których dotyczą te zdarzenia. Jeśli na przykład wybierzesz zdarzenie poprawiony abonament, zostanie wysłane tylko powiadomienie do deweloperów, którzy je zaakceptowali.

Tabela poniżej zawiera listę powiadomień według typów zdarzeń w sekcji Powiadom deweloperów, których dotyczy problem. Więcej informacji znajdziesz w artykule Edytowanie powiadomień przy użyciu interfejsu użytkownika.

Typ zdarzenia Aktywator Uwagi
Warunki nie zostały zaakceptowane lub wygasły Opublikowano nowy zestaw warunków, ale deweloper jeszcze ich nie zaakceptował

Powiadomienie jest wysyłane na 30 dni, 7 dni i 1 dzień przed wejściem w życie nowych warunków.
Nowy plan stawek Opublikowano nowe plany stawek

Jeśli abonament to:

  • Abonament standardowy, wszyscy deweloperzy otrzymują powiadomienia.
  • plan stawek według kategorii deweloperów, powiadomienia otrzymują tylko deweloperzy z tej kategorii.
  • Plan cenowy dewelopera, powiadomienia otrzymują tylko konkretny deweloper.
Zmieniony abonament Dostępna jest nowsza wersja zakupionego abonamentu

Powiadomimy Cię tylko deweloperów, którzy kupili aktualną wersję. Deweloperzy będą mogli sprawdzić nową wersję i zamknąć lub zmienić abonament, jeśli nie zaakceptują nowych stawek.
Wygasły abonament Abonament wygasł bez dodatkowego planu cen

To powiadomienie jest wysyłane po początkowym ustawieniu wygaśnięcia abonamentu. Dodatkowe powiadomienia są wysyłane 30, 7 i 1 dzień przed datą wygaśnięcia abonamentu. Powiadomimy Cię tylko deweloperów, którzy kupili abonament, który ma wygasnąć.
Odnowiony abonament Subskrypcja abonamentu została odnowiona.

Poinformuj dewelopera, że zostaną naliczone obowiązujące opłaty.
Przekroczono limit ruchu Przekroczono limit abonamentu

Poinformuj dewelopera, że zostaną naliczone obowiązujące opłaty.
Wyczerpany abonament Freemium Okresy bezpłatnego korzystania z aplikacji wyczerpane na podstawie liczby transakcji lub dni zostały wyczerpane

Okres bezpłatnego korzystania jest określany przez Twój abonament freemium.
Dokument rozliczeniowy został opublikowany

Dostępne są dokumenty rozliczeniowe (np. faktury) dewelopera.
Deweloper zgłasza się do nowego abonamentu Deweloper rejestruje nowy abonament.

Edytowanie powiadomień wysyłanych do dostawców interfejsu API powiadomień

Powiadomienia o typach zdarzeń wybranych w sekcji Powiadom dostawcę interfejsu API są wysyłane do określonego przez Ciebie dostawcy interfejsu API.

Poniższa tabela zawiera listę powiadomień według typów zdarzeń w sekcji Powiadom dostawcę interfejsu API. Więcej informacji znajdziesz w artykule Edytowanie powiadomień przy użyciu interfejsu użytkownika.

Typ zdarzenia Aktywator
Rejestracja nowego dewelopera

Deweloper zarejestrował konto.
Dodaje aplikację

Programista utworzył nową aplikację.
Rejestracja dewelopera w nowym abonamencie

Deweloper zasubskrybował plan taryfowy.
Deweloper zmienia informacje finansowe

Deweloper zmienił dane finansowe, np. nazwę lub adres firmy.

Włączanie i wyłączanie powiadomień

Aby włączyć lub wyłączyć powiadomienia w interfejsie:

  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. Kliknij Zapisz, aby zapisać wszystkie zmiany.

Zapisywanie może potrwać kilka minut. Wyświetli się komunikat potwierdzający zapisanie powiadomień.

Konfigurowanie powiadomień za pomocą szablonów za pomocą interfejsu 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 zgodnie z opisem w tych sekcjach:

Wyświetlanie wszystkich szablonów powiadomień przy użyciu interfejsu API

Aby wyświetlić listę wszystkich szablonów powiadomień dostępnych na potrzeby zarabiania, wyślij żądanie GET 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

Na przykład ten 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 zaczynające się od znaku $ są zmiennymi. Więcej informacji znajdziesz w artykule o korzystaniu ze zmiennych w szablonach powiadomień. Załóżmy, że zmienne w powiadomieniu przyjmują te 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

Powiadomienie z szablonu będzie wyglądać tak:

    "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ń przy użyciu interfejsu API

Aby edytować szablon powiadomienia, wyślij żądanie PUT do /nint/organizations/{org_name}/notification-email-templates/{template_id}. Podaj zmienioną treść szablonu w treści żądania.

Dostosowując wiadomość w szablonie powiadomienia, możesz dodać 1 lub więcej zmiennych. Więcej informacji znajdziesz w artykule o używaniu zmiennej w szablonach powiadomień.

Na przykład to żądanie edytuje treść nowego powiadomienia dotyczącego usługi 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 powiadomień i działaniami za pomocą interfejsu API

Zarządzaj warunkami powiadomień i działaniami za pomocą interfejsu API w sposób opisany w poniższych sekcjach.

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

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

Przesyłając żądanie, określ w treści żądania warunek, którego ono dotyczy, oraz działania, które mają zostać wykonane po jego spełnieniu (np. wysłanie e-maila z powiadomieniem).

Aby określić szczegóły warunku powiadomienia, podaj co najmniej 1 wartość atrybutu. Listę atrybutów znajdziesz w sekcji Właściwości konfiguracji warunków powiadomień. W przypadku powiadomienia o zdarzeniu warunek może zostać aktywowany po opublikowaniu nowej usługi.

Podczas definiowania actions skorzystaj z odpowiedniego szablonu powiadomienia. 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 gdy atrybut ma wartość NEW_PRODUCT, a wartość atrybutu PUBLISHED to true, wyślij w szablonie powiadomienie z identyfikatorem 01191bf9-5fdd-45bf-8130-3f024694e63 (czyli 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 czynności 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 podczas tworzenia warunku 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

Poniżej znajdziesz przykładową odpowiedź:

    {
    "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 czynności za pomocą interfejsu API

Aby zmienić warunek powiadomienia i działanie, wyślij żądanie POST do organizations/{org_name}/notification-conditions/{condition_Id}, gdzie {condition_Id} to identyfikator warunku. Identyfikator jest zwracany podczas tworzenia warunku powiadomienia. Gdy wysyłasz żądanie, w jego treści określ zmiany, które chcesz wprowadzić w warunku powiadomienia lub działaniu.

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 powiadomienia i czynności 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 powiadomień

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

Nazwa Opis Domyślne Wymagana?
attribute

Szczegóły warunku powiadomienia. Aby doprecyzować warunek powiadomienia, możesz podać jeden lub więcej atrybutów.

Możliwe wartości to:

  • 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 (dotyczy tylko konfigurowania webhooków)
 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 dla działań związanych z powiadomieniami podczas korzystania z interfejsu API.

Nazwa Opis Domyślne Wymagana?
actionAttribute

Metoda używana do identyfikacji odbiorcy powiadomienia. Możliwe wartości:

  • ORG_EMAIL. Odbiorca powiadomienia jest identyfikowany na podstawie adresu e-mail.
  • DEV_ID. Odbiorca powiadomienia jest identyfikowany na podstawie identyfikatora dewelopera (adresu e-mail).
  • COMPANY_ADMINS. Powiadomienie jest wysyłane do wszystkich administratorów w firmie niezależnie od ustawionej wartości. Pamiętaj, że administratorzy w firmie to nie są administratorzy organizacji.
  • WEBHOOK. Informacje o adresacie powiadomień są wysyłane do modułu obsługi wywołania zwrotnego webhooka. Przeczytaj artykuł o konfigurowaniu powiadomień za pomocą webhooków.
 Nie dotyczy Tak
value

Wartość atrybutu działania.

Jeśli actionAttribute ma wartość ORG_EMAIL lub DEV_ID, wartość ANY wysyła powiadomienie do odpowiedniego odbiorcy, na przykład dowolnego adresu ORG_EMAIL lub 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; powiadomienie jest wysyłane do wszystkich administratorów firmy.

 Nie dotyczy Tak
templateID

Identyfikator szablonu powiadomienia.

Uwaga: ta opcja nie jest prawidłowa, jeśli actionAttribute ma wartość WEBHOOK.

 Nie dotyczy Tak
postURL

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

Uwaga: ta opcja jest wymagana, jeśli actionAttribute ma wartość 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 dołączyć do niej 1 lub więcej zmiennych za pomocą języka Spring Expression (SpEL) do reprezentowania wartości zwracanych w obiekcie Transaction (Transakcja).

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 zawartej w aplikacji.
${BALANCE} Saldo przypisane do danego limitu.
${developer.legalName}

Nazwa firmy dewelopera.
${developer.name}

Imię i nazwisko dewelopera
${EXPIRY_DATE}

Data lub godzina, kiedy limit wygasa lub jest resetowany.
${LONG_PERCENT} Wartość procentowa limitu osiągniętego przy bieżącym wykorzystaniu, bez symbolu %. Na przykład 50
${PERCENT}

Procent osiągnięcia limitu przy bieżącym wykorzystaniu (% symboli). Na przykład 50%.
${products.displayName} Wyświetlana nazwa zdefiniowana dla produktu.
${QUOTA_TYPE}

Typ limitu (liczba transakcji, limit wydatków lub ekspozycja na opłaty).
${QUOTA_UNIT}

Podstawowa jednostka limitu: waluta (w przypadku limitu wydatków) lub wywołania (limit transakcji).
${QUOTA_LIMIT}

Kwota limitu.
${ratePlan.displayName} Wyświetlana nazwa zdefiniowana na potrzeby planu stawek.
${ratePlan.endDate} Data zakończenia przez dostawcę interfejsu API planu opłat.
${ratePlan.monetizationPackage.displayName}

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

Wyświetlana nazwa zdefiniowana dla usługi API.
${ratePlan.monetizationPackage.products.name} Nazwa produktu w pakiecie zarabiania.
${ratePlan.startDate} Data utworzenia planu stawek.
${USAGE} Obecne wykorzystanie (łączne przychody, opłaty lub liczba operacji)
${USER}

Nazwa użytkownika.

Dostosowywanie zwrotnego adresu e-mail

Na potrzeby zarabiania na e-mailach z powiadomieniami wysyłanymi do firm i deweloperów jest skonfigurowany domyślny adres noreply@apigee.com. Skontaktuj się z zespołem pomocy Apigee, aby skonfigurować niestandardową nazwę odpowiedzi i adres w swojej organizacji.