Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info
Co to są szablony powiadomień?
Funkcja zarabiania udostępnia zestaw szablonów, które definiują przykładowy tekst dla różnych typów powiadomień o zdarzeniach. Możesz dostosować dowolny z tych szablonów, aby:
- Powiadamiaj wszystkich deweloperów o wydarzeniach takich jak nowe produkty, nowe wersje warunków lub nowe plany stawek.
- Powiadomienie deweloperów, których to dotyczy, o zdarzeniach, takich jak zmieniony plan cen.
- powiadamiać dostawcę interfejsu API o zdarzeniach związanych z deweloperami, np. o zarejestrowaniu się dewelopera na koncie lub o zasubskrybowaniu przez niego cennika;
- Powiadomienie wszystkich administratorów firmy o określonym zdarzeniu.
Możesz też utworzyć webhook, który definiuje wywołanie zwrotne HTTP, a potem skonfigurować warunek, który uruchamia webhook zgodnie z opisem w sekcji Konfigurowanie powiadomień za pomocą webhooków.
Poznawanie strony Powiadomienia
Otwórz stronę Powiadomienia w sposób opisany poniżej.
Edge
Aby uzyskać dostęp do strony powiadomień za pomocą interfejsu Edge:
- Zaloguj się na stronie apigee.com/edge.
- Na pasku nawigacyjnym po lewej stronie kliknij Opublikuj > Generowanie przychodu > Powiadomienia.
Pojawi się strona Powiadomienia.
Jak zaznaczono na ilustracji, strona Powiadomienia umożliwia:
- Rozwijanie i zwijanie szczegółów powiadomienia
- Edytowanie szczegółów powiadomienia i zapisywanie wszystkich zmian
- Włączanie i wyłączanie powiadomienia
Classic Edge (Private Cloud)
Aby uzyskać dostęp do strony Powiadomienia za pomocą interfejsu użytkownika klasycznej wersji Edge:
- Zaloguj się na stronie
http://ms-ip:9000
, gdzie ms-ip to adres IP lub nazwa DNS węzła serwera zarządzania. Na górnym pasku nawigacyjnym wybierz Administracja > Powiadomienia.
Na stronie Powiadomienia możesz:
Edytowanie powiadomień
Aby edytować powiadomienie w interfejsie:
- Otwórz stronę Powiadomienia.
- Kliknij obok powiadomienia, które chcesz edytować, aby wyświetlić jego szczegóły.
- W razie potrzeby zmień pola Temat, Treść i Odbiorca (jeśli jest dostępny).
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 tych sekcjach:
- Aby włączyć powiadomienie, zaznacz obok niego pole wyboru.
- Powtórz kroki 2–4, aby edytować dodatkowe powiadomienia.
- 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ń, aby wysyłać je do wszystkich deweloperów
Powiadomienia o typach zdarzeń wybranych w sekcji Powiadom wszystkich deweloperów są wysyłane do wszystkich deweloperów.
Powiadomienia są zaplanowane na koniec dnia. Po wysłaniu powiadomień pola wyboru wydarzeń są automatycznie odznaczane. Aby zaplanować powiadomienia dla powiązanych typów zdarzeń, musisz je ponownie wybrać.
W tabeli poniżej znajdziesz powiadomienia o wydarzeniach oparte na typach zdarzeń w sekcji Powiadomienie wszystkich deweloperów. Więcej informacji znajdziesz w artykule Edycja powiadomień za pomocą interfejsu użytkownika.
Typ zdarzenia | Aktywator | Uwagi |
---|---|---|
Nowy pakiet | Dostępny jest nowy pakiet interfejsów API |
W ramach aktualizacji dodaj nazwę każdego nowego pakietu (oraz produktów zawartych w każdym pakiecie) do treści szablonu e-maila. Możesz też dodać link do portalu dla deweloperów lub innej witryny zawierającej więcej informacji na temat powiadomienia. |
Nowy produkt | Dostępny jest nowy produkt interfejsu API |
W treści szablonu e-maila dodaj nazwę każdego nowego produktu w ramach aktualizacji. Możesz też dodać link do portalu dla deweloperów lub innej witryny zawierającej więcej informacji na temat powiadomienia. |
Nowe rynki/zasięg | Nowe usługi interfejsu API są dostępne na wybranych rynkach geograficznych |
W treści szablonu e-maila dodaj nazwę każdego nowego rynku i odpowiednie produkty. 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 typy zdarzeń. Jeśli na przykład wybierzesz zdarzenie Zmieniony plan stawek, powiadomienie zostanie wysłane tylko do tych deweloperów, którzy zaakceptowali ten plan.
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 Edycja powiadomień za pomocą interfejsu użytkownika.
Typ zdarzenia | Aktywator | Uwagi |
---|---|---|
Warunki usługi nie zostały zaakceptowane lub utraciły ważność | opublikowano nowy zestaw warunków, którego deweloper jeszcze nie zaakceptował; |
Powiadomienie jest wysyłane 30 dni, 7 dni i 1 dzień przed wejściem w życie nowych warunków korzystania z usługi. |
Nowy plan stawek | Opublikowano nowe abonamenty |
Jeśli plan cen obejmuje:
|
Skorygowany plan taryf | Dostępna jest nowsza wersja zakupionego abonamentu |
Powiadomienia otrzymają tylko deweloperzy, którzy kupili bieżącą wersję. Powiadomienie umożliwia deweloperom zapoznanie się z nową wersją i anulowanie lub zmianę abonamentu, jeśli nie chcą zaakceptować nowych stawek. |
Plan stawek wygasł | Pakiet cen wygasł i nie ma kolejnego pakietu cen |
To powiadomienie jest wysyłane, gdy po raz pierwszy ustawisz datę wygaśnięcia planu cenowego. Dodatkowe powiadomienia są wysyłane 30, 7 i 1 dzień przed datą wygaśnięcia. Powiadomimy o tym tylko tych deweloperów, którzy kupili abonament w celu wygaśnięcia abonamentu. |
Odnowiony plan stawek | Subskrypcja abonamentu została odnowiona. |
Poinformuj dewelopera, że zostaną naliczone odpowiednie opłaty. |
Przekroczono limit częstotliwości | Przekroczono limit planu cenowego |
Poinformuj dewelopera, że zostaną naliczone odpowiednie opłaty. |
Zbyt niski abonament freemium | Okresy bezpłatnego użytkowania mierzone za pomocą liczby transakcji lub dni zostały wyczerpane |
Okres bezpłatnego korzystania jest określony w ramach Twojego planu cenowego freemium. |
Dokument rozliczeniowy został opublikowany |
Dokumenty rozliczeniowe (np. faktury) dewelopera są dostępne. |
|
Deweloper rejestruje się w ramach nowego abonamentu | deweloper zarejestruje się w nowym planie cen, |
Edytowanie powiadomień wysyłanych do dostawców interfejsu Notify API
Powiadomienia o typach zdarzeń wybranych w sekcji Powiadomienie dostawcy interfejsu API są wysyłane do podanego przez Ciebie dostawcy interfejsu API.
W tabeli poniżej znajdziesz powiadomienia oparte na typach zdarzeń w sekcji Dostawca interfejsu Notify API. Więcej informacji znajdziesz w artykule Edytowanie powiadomień w interfejsie.
Typ zdarzenia | Aktywator |
---|---|
Rejestracja nowego dewelopera |
deweloper zarejestrował konto; |
Deweloper dodaje aplikację |
Programista utworzył nową aplikację. |
Rejestracja dewelopera i nowy abonament |
Deweloper zapisał się do planu taryfowego. |
Deweloper zmienia szczegóły dotyczące płatności |
deweloper zmienił informacje finansowe, takie jak nazwa lub adres firmy; |
Włączanie i wyłączanie powiadomień
Aby włączyć lub wyłączyć powiadomienie za pomocą interfejsu użytkownika:
- Otwórz stronę Powiadomienia.
- Włącz lub wyłącz powiadomienie, odpowiednio zaznaczając lub odznaczając obok niego pole wyboru.
- 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 za pomocą interfejsu API
Skonfiguruj powiadomienia za pomocą interfejsu API zgodnie z opisem w następnych sekcjach.
Zarządzanie szablonami powiadomień za pomocą interfejsu API
Zarządzaj szablonami powiadomień za pomocą interfejsu API zgodnie z opisem w sekcjach:
- Wyświetlanie wszystkich szablonów powiadomień za pomocą interfejsu API
- Wyświetlanie szablonu powiadomienia za pomocą interfejsu API
- Edycja szablonu powiadomienia za pomocą interfejsu API
Wyświetlanie wszystkich szablonów powiadomień za pomocą interfejsu API
Aby wyświetlić wszystkie szablony powiadomień, które udostępnia funkcja zarabiania, wyślij żądanie GET do adresu /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
Poniżej znajdziesz przykład szablonu zdarzenia, który informuje deweloperów o dostępności nowej usługi interfejsu 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 za pomocą interfejsu API
Aby wyświetlić szablon powiadomienia, wyślij żądanie GET do adresu /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 $, są zmiennymi. Więcej informacji znajdziesz w artykule Używanie zmiennych w szablonach powiadomień. Załóżmy, że zmienne w powiadomieniu mają 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
Treść powiadomienia generowanego przez szablon:
"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 powiadomienia za pomocą interfejsu API
Aby edytować szablon powiadomienia, wyślij żądanie PUT do adresu /nint/organizations/{org_name}/notification-email-templates/{template_id}
.
W treści żądania podaj zmienioną treść szablonu.
Podczas dostosowywania wiadomości w szablonie powiadomienia możesz użyć co najmniej 1 zmiennej. Więcej informacji znajdziesz w artykule Używanie zmiennych w szablonach powiadomień.
Na przykład to żądanie zmienia treść powiadomienia o nowym produkcie w 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 powiadomienia za pomocą interfejsu API
Zarządzaj warunkami i działaniami powiadomień za pomocą interfejsu API zgodnie z opisem w następnych sekcjach.
- Tworzenie warunku i działania powiadomienia za pomocą interfejsu API
- Wyświetlanie warunku i działania powiadomienia za pomocą interfejsu API
- Edytowanie warunku i działania powiadomienia za pomocą interfejsu API
- Usuwanie warunku i działania powiadomienia za pomocą interfejsu API
Tworzenie warunku i działania powiadomienia za pomocą interfejsu API
Aby utworzyć warunek powiadomienia i działanie, które powoduje automatyczne powiadomienie, wyślij żądanie POST do adresu /mint/organizations/{org_name}/notification-conditions
.
Gdy wysyłasz żądanie, w jego treści podaj warunek, który powoduje wysłanie powiadomienia, oraz działania, które mają być wykonane po spełnieniu tego warunku (np. wysłanie e-maila z powiadomieniem).
Szczegóły warunku powiadamiania możesz zdefiniować, określając co najmniej 1 wartość atrybutu. Listę atrybutów znajdziesz w sekcji Właściwości konfiguracji warunków powiadamiania. W przypadku powiadomienia o zdarzeniu warunek może zostać spełniony, gdy zostanie opublikowany nowy produkt.
Podczas definiowania parametru actions
odwołuj się do odpowiedniego szablonu powiadomienia. Listę działań znajdziesz w sekcji Właściwości konfiguracji działań powiadomień.
Na przykład to żądanie określa, że gdy atrybut to NEW_PRODUCT
, a wartość atrybutu PUBLISHED
to true
, należy wysłać powiadomienie w szablonie o identyfikatorze 01191bf9-5fdd-45bf-8130-3f024694e63
(jest to 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 i działania powiadomienia za pomocą interfejsu API
Aby wyświetlić warunek i działanie powiadomienia, wyślij żądanie GET do adresu 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 przedstawiamy przykład 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 i działania powiadomienia za pomocą interfejsu API
Aby edytować warunek i działanie powiadomienia, wyślij żądanie POST do adresu organizations/{org_name}/notification-conditions/{condition_Id}
, gdzie {condition_Id}
to identyfikator warunku. Identyfikator jest zwracany, gdy utworzysz warunek powiadomienia. Podczas wysyłania żądania w treści żądania podaj zmiany, które chcesz wprowadzić 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 i działania powiadomienia za pomocą interfejsu API
Aby usunąć warunek powiadomienia, wyślij żądanie usunięcia do adresu 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 powiadamiania.
Nazwa | Opis | Domyślny | Wymagany? |
---|---|---|---|
attribute |
Szczegóły warunku powiadomienia. Aby doprecyzować warunek powiadomienia, możesz podać co najmniej 1 atrybut. Wartość może być jedną z tych wartości:
|
Nie dotyczy | Tak |
value |
Wartość atrybutu. |
Nie dotyczy | Nie |
associatedCondition |
Odwołanie do powiązanego warunku. |
Nie dotyczy | Nie |
Właściwości konfiguracji działań związanych z powiadomieniami
W przypadku działań związanych z powiadomieniami dostępne są te właściwości konfiguracji:
Nazwa | Opis | Domyślny | Wymagany? |
---|---|---|---|
actionAttribute |
Metoda identyfikacji odbiorcy powiadomienia. Wartość może być 1 z tych elementów:
|
Nie dotyczy | Tak |
value |
Wartość atrybutu action. Jeśli Jeśli Jeśli zasada |
Nie dotyczy | Tak |
templateID |
Identyfikator szablonu powiadomienia. Uwaga: ta opcja nie jest prawidłowa, jeśli wartość parametru |
Nie dotyczy | Tak |
postURL |
Moduł obsługi wywołania zwrotnego dla webhooka. Uwaga: ta opcja jest wymagana, jeśli |
Nie dotyczy | Tak |
Używanie zmiennych w szablonach powiadomień
Podczas edytowania wiadomości w szablonie powiadomienia możesz użyć jednej lub więcej zmiennych za pomocą języka wyrażeń Spring (SpEL) do reprezentowania wartości zwracanych przez obiekt Transaction.
W tabeli poniżej znajdziesz podsumowanie najczęściej używanych zmiennych szablonu powiadomienia.
Zmienna | Opis |
---|---|
${application.name} |
Nazwa aplikacji. |
${application.products.name} |
Nazwa produktu zawartego w aplikacji. |
${BALANCE} |
Saldo określonej puli. |
${developer.legalName} |
Nazwa firmy dewelopera. |
${developer.name} |
Imię i nazwisko dewelopera. |
${EXPIRY_DATE} |
Data lub godzina, w której limit wygasa lub zostaje zresetowany. |
${LONG_PERCENT} |
Procent limitu osiągniętego przez bieżące wykorzystanie bez symbolu %. Na przykład 50 |
${PERCENT} |
Procent limitu osiągniętego przez bieżące wykorzystanie z symbolem %. np. 50%. |
${products.displayName} |
Wyświetlana nazwa zdefiniowana dla usługi. |
${QUOTA_TYPE} |
Typ limitu (limit liczby transakcji, limit wydatków lub ekspozycja opłat). |
${QUOTA_UNIT} |
Podstawowa jednostka limitu: waluta (w przypadku limitu wydatków) lub połączenia (w przypadku limitu transakcji). |
${QUOTA_LIMIT} |
Wielkość limitu. |
${ratePlan.displayName} |
Wyświetlana nazwa zdefiniowana dla planu taryfowego. |
${ratePlan.endDate} |
Data, kiedy dostawca interfejsu API zakończył stosowanie cennika. |
${ratePlan.monetizationPackage.displayName} |
Nazwa pakietu interfejsu API. |
${ratePlan.monetizationPackage.name} |
Nazwa pakietu Monetyzacja. |
${ratePlan.monetizationPackage.products.displayName} |
Wyświetlana nazwa zdefiniowana dla usługi API. |
${ratePlan.monetizationPackage.products.name} |
Nazwa produktu zawartego w pakiecie Monetyzacja. |
${ratePlan.startDate} |
Data utworzenia planu cenowego. |
${USAGE} |
bieżące wykorzystanie (łączne przychody lub opłaty, łączna liczba jednostek). |
${USER} |
Nazwa użytkownika. |
Dostosowywanie adresu e-mail zwrotnego
W przypadku generowania przychodu domyślnie używany jest adres noreply@apigee.com do wysyłania e-maili z powiadomieniami do firm i programistów. Skontaktuj się z zespołem pomocy Apigee, aby skonfigurować niestandardową nazwę odpowiedzi i adres dla swojej organizacji.