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

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Czym są szablony powiadomień?

Sekcja Zarabianie udostępnia zestaw szablonów, które zawierają przykładowy tekst różnych typów powiadomień o zdarzeniach. Możesz dostosować dowolny z tych szablonów, aby:

• Powiadamianie wszystkich deweloperów o wydarzeniach takich jak nowe produkty, nowe wersje Warunków korzystania z usługi czy nowe plany cenowe.
• Powiadamianie deweloperów, których to dotyczy, o wydarzeniach takich jak zmieniony plan stawek.
• Powiadamianie dostawcy interfejsu API o zdarzeniach związanych z deweloperami, np. gdy deweloper zarejestruje konto lub wykupi abonament.
• Powiadamianie wszystkich administratorów firmy o określonym zdarzeniu.

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

Otwieranie strony Powiadomienia

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

Powiadomienia o edycji

Aby edytować powiadomienie w interfejsie:

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

   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:

   • Edytowanie powiadomień, aby powiadomić wszystkich deweloperów
   • Edytowanie powiadomień, aby informować deweloperów, których dotyczy problem
   • Edytowanie powiadomień do dostawców interfejsu Notify API
4. Włącz powiadomienie, zaznaczając pole wyboru obok niego.
5. Aby edytować kolejne powiadomienia, powtórz kroki 2–4.
6. Aby zapisać wszystkie zmiany, kliknij Zapisz.

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

Edytowanie powiadomień, aby powiadamiać 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 zdarzeń zostaną automatycznie wyczyszczone. Aby zaplanować powiadomienia o powiązanych typach zdarzeń, musisz je ponownie wybrać.

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

Edytowanie powiadomień, aby informować deweloperów, których dotyczą zmiany

Powiadomienia o rodzajach zdarzeń wybranych w sekcji Powiadom deweloperów, których dotyczy problem są wysyłane tylko do deweloperów, których dotyczą te rodzaje zdarzeń. Jeśli na przykład wybierzesz zdarzenie Zmieniony plan cenowy, powiadomienie zostanie wysłane tylko do deweloperów, którzy zaakceptowali plan cenowy.

W tabeli poniżej znajdziesz powiadomienia oparte na typach zdarzeń w sekcji Powiadomienie deweloperów, których dotyczy problem. Więcej informacji znajdziesz w artykule Edytowanie powiadomień w interfejsie.

Edytowanie powiadomień do dostawców interfejsów API

Powiadomienia o typach zdarzeń wybranych w sekcji Powiadom dostawcę interfejsu API są wysyłane do określonego 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.

Włączanie i wyłączanie powiadomień

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

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

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

Konfigurowanie powiadomień za pomocą szablonów przy użyciu interfejsu API

Skonfiguruj powiadomienia za pomocą interfejsu API zgodnie z opisem w sekcjach poniżej.

Zarządzanie szablonami powiadomień za pomocą interfejsu API

Zarządzaj szablonami powiadomień za pomocą interfejsu API zgodnie z opisem w tych sekcjach:

• Wyświetlanie wszystkich szablonów powiadomień za pomocą interfejsu API
• Wyświetlanie szablonu powiadomienia za pomocą interfejsu API
• Edytowanie szablonu powiadomienia za pomocą interfejsu API

Wyświetlanie wszystkich szablonów powiadomień za pomocą interfejsu API

Możesz wyświetlić listę wszystkich szablonów powiadomień udostępnianych przez funkcję zarabiania, wysyłając żą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

Na przykład ten szablon zdarzenia powiadamia deweloperów o dostępności nowego produktu 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 $, to zmienne. 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

Powiadomienie podane przez szablon 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 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.

Dostosowując wiadomość w szablonie powiadomienia, możesz uwzględnić w niej co najmniej 1 zmienną. Więcej informacji znajdziesz w artykule Używanie zmiennych w szablonach powiadomień.

Na przykład to żądanie edytuje treść nowego powiadomienia o produkcie 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 powiadomień za pomocą interfejsu API

Warunkami i działaniami związanymi z powiadomieniami możesz zarządzać za pomocą interfejsu API, jak opisano w kolejnych sekcjach.

• Tworzenie warunku powiadomienia i działania 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 powiadomienia i działania za pomocą interfejsu API

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

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

W treści żądania określ warunek, który spowoduje wysłanie powiadomienia, oraz działania, które mają zostać podjęte po spełnieniu tego warunku (np. wysłanie e-maila z powiadomieniem).

Szczegóły warunku powiadomienia możesz zdefiniować, określając co najmniej 1 wartość atrybutu. Listę atrybutów znajdziesz w artykule Właściwości konfiguracji warunków powiadomień. W przypadku powiadomienia o wydarzeniu warunek może zostać spełniony, gdy opublikowany zostanie nowy produkt.

Podczas definiowania parametru actions odwołaj się do odpowiedniego szablonu powiadomienia. Listę działań znajdziesz w artykule Właściwości konfiguracji działań powiadomień.

Na przykład poniższa prośba 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 powiadomienia i działania za pomocą interfejsu API

Aby wyświetlić warunek powiadomienia i działanie, wyślij żą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

Oto 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

Edytuj warunek i działanie powiadomienia, wysyłając żądanie POST do adresu organizations/{org_name}/notification-conditions/{condition_Id}, gdzie {condition_Id} to identyfikator warunku. Identyfikator jest zwracany podczas tworzenia warunku powiadomienia. W treści żądania 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 działania za pomocą interfejsu API

Aby usunąć warunek powiadomienia, wyślij żądanie DELETE 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ą te właściwości konfiguracji warunków powiadomień:

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

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

Używanie zmiennych w szablonach powiadomień

Podczas edytowania wiadomości w szablonie powiadomienia możesz uwzględnić co najmniej jedną zmienną, używając języka Spring Expression Language (SpEL), aby reprezentować wartości zwracane w obiekcie Transaction.

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

Dostosowywanie adresu e-mail, na który mają być wysyłane odpowiedzi

W przypadku generowania przychodu domyślny adres noreply@apigee.com jest skonfigurowany do wysyłania powiadomień e-mail do firm i deweloperów. Aby skonfigurować niestandardową nazwę i adres odpowiedzi dla organizacji, skontaktuj się z zespołem pomocy Apigee.