Konfigurowanie powiadomień o limitach

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Wprowadzenie

Możesz ustawić limity związane z zarabianiem, jak opisano w sekcji Wymuszanie limitów zarabiania za pomocą zasady sprawdzania limitów zarabiania. Możesz też skonfigurować automatyczne powiadomienia, które będą ostrzegać deweloperów, lub użytkowników w Twojej organizacji, gdy limit będzie się zbliżać lub zostanie osiągnięty.

Możesz skonfigurować automatyczne powiadomienia dotyczące limitów niestandardowych oraz limitów domyślnych. Na przykład system ustawia domyślny limit dla deweloperów korzystających z przedpłaty, który jest równy ich saldu przedpłaty. Możesz skonfigurować automatyczne powiadomienia, aby deweloperzy byli powiadamiani, gdy zbliżają się do salda z przedpłaty lub je osiągną.

Zestaw narzędzi

Automatyczne powiadomienia o limitach możesz skonfigurować za pomocą interfejsu zarządzania lub interfejsu API zarabiania. Jeśli korzystasz z interfejsu, automatyczne powiadomienia konfigurujesz na stronie Powiadomienia.

Jeśli korzystasz z interfejsu API, automatyczne powiadomienia o limitach konfigurujesz, edytując szablon powiadomień udostępniony przez zarabianie. Następnie określasz warunek, który powoduje wysłanie powiadomienia z edytowanego szablonu.

Konfigurowanie powiadomień o limitach za pomocą interfejsu

  1. Na stronie Dodaj limit w sekcji Powiadomienia kliknij Dodaj. Otworzy się sekcja Powiadomienia.

  2. Wybierz poziom powiadomienia. Jest to próg oparty na liczbie bezwzględnej lub procentowej podstawie limitu. Wybierz:
    • znak większości lub równości (?) albo znak mniejszości lub równości (?) z menu.
    • liczbę całkowitą (bez miejsc po przecinku). Wartość bezwzględna (aby wskazać wartość liczbową) lub Procent (aby wskazać wartość procentową). W przypadku limitów procentowych zawsze ustawiaj limit jako >, co oznacza, że powiadomienie zostanie wysłane, gdy deweloper osiągnie lub przekroczy ten poziom procentowy.

    Jeśli na przykład ustawisz limit wydatków na 100 USD i powiadomienie na poziomie większym lub równym 90%, powiadomienie zostanie wysłane, gdy zostanie osiągnięty lub przekroczony poziom 90% limitu (90 USD).

  3. W polu Wyślij e-maila wybierz co najmniej 1 dewelopera lub co najmniej 1 użytkownika w swojej organizacji. Powiadomienie zostanie wysłane do deweloperów lub użytkowników, których dotyczy ta zmiana.

    Odbiorcy e-maili: powiadomienia możesz wysyłać tylko do deweloperów, jeśli ustawisz warunek limitu dewelopera na „Dowolny” lub ustawisz warunek limitu dewelopera z konkretnym deweloperem. Jeśli wybierzesz „Dowolny”, na liście adresów e-mail zobaczysz „Wybrany deweloper (dowolny)”. Oznacza to, że zarabianie wyśle powiadomienie do wszystkich deweloperów, których dotyczy ta zmiana. Jeśli wybierzesz konkretnego dewelopera, na liście adresów e-mail zobaczysz „Wybrany deweloper ({developer_id})” (gdzie {developer_id} to identyfikator wybranego dewelopera). Zarabianie wyśle powiadomienie tylko do tego dewelopera.

    Jeśli nie wybierzesz warunku limitu dewelopera „Dowolny” ani konkretnego dewelopera, nie zobaczysz „Wybrany deweloper (dowolny)” w polu Wyślij e-maila. Możesz jednak wybrać których użytkowników w organizacji chcesz powiadomić.

    Adresy e-mail użytkowników w organizacji możesz dodać, wybierając Użytkownicy organizacji na karcie Administracja.

    Szablony e-maili: szablon e-maila zobaczysz, gdy w polu Wyślij e-maila wybierzesz „Wybrany deweloper (dowolny)” lub adresy e-mail użytkowników w organizacji (albo obie te opcje).To, co pojawi się w szablonie, zależy od tych czynników:

    • poziom powiadomienia;
    • czy limit był limitem wstrzymania wykonania;
    • czy e-mail był przeznaczony dla użytkowników organizacji, deweloperów czy obu tych grup.

    Jeśli na przykład spełnione są wszystkie te warunki:

    • Zaznaczone jest pole wyboru Wstrzymaj wykonanie.
    • Poziom powiadomienia to 100% lub taka sama kwota jak limit.
    • E-mail jest przeznaczony tylko dla użytkowników organizacji.

    Szablon wygląda tak:

    Załóżmy, że nazwa firmy dewelopera to „XYZ company”, limit liczby transakcji wynosi 50 w przypadku pakietu API o nazwie „X Package” i produktu API o nazwie „Y Product”, a data ważności to 30 września 2013 r. Wysłana wiadomość e-mail będzie wyglądać tak:

    Developer XYZ company has exceeded their transaction volume limit of 50 transactions for X package, Y product. Their API calls will be blocked till 2013-09-30

    Jeśli e-mail jest przeznaczony dla „Wybrany deweloper (dowolny)”, szablon wygląda tak:

    Oba szablony rozwiążą odpowiednie zmienne, takie jak nazwa dewelopera (jeśli dotyczy), nazwa pakietu (jeśli dotyczy) i nazwa produktu (jeśli dotyczy). Aby dostosować wiadomość do swoich potrzeb, kliknij Edytuj po lewej stronie szablonu.

    Jeśli limit dotyczy "Dowolnej" lub konkretnej aplikacji oraz "Dowolnego" lub konkretnego użytkownika, musisz też dodać do szablonu zmienne dla aplikacji i użytkowników. Możesz to zrobić tak:

    • Kliknij Edytuj po lewej stronie szablonu.
    • Dodaj ${user.name} user, depending on whether the limit is for application and/or user.

    Poniżej znajdziesz szablon edytowany pod kątem „Dowolnej” lub konkretnej aplikacji.

    Jeśli pole wyboru Wstrzymaj wykonanie nie jest zaznaczone lub poziom powiadomienia jest większy lub równy 100%, szablon dla wybranego dewelopera wygląda tak:

    Jeśli limit dotyczy "Dowolnej" (lub konkretnej) aplikacji albo "Dowolnego" (lub konkretnego) użytkownika, musisz ponownie edytować szablon, a następnie dodać ${application.name} aplikację lub ${user.name} użytkownika w zależności od tego, czy limit dotyczy aplikacji, użytkownika czy obu tych elementów.

    Zmienne szablonu: podczas edytowania wiadomości w szablonie e-maila możesz uwzględnić dowolną z tych zmiennych.

    Zmienna Opis
    ${developer.name}

    Nazwa dewelopera.
    ${developer.legalName}

    Nazwa firmy dewelopera.
    ${ratePlan.monetizationPackage.displayName}

    Nazwa pakietu API.
    ${application.name}

    Nazwa aplikacji.
    ${USER}

    Nazwa użytkownika.
    ${USAGE}

    Bieżące wykorzystanie (łączny przychód lub opłaty albo liczba).
    ${PERCENT}

    Procent limitu osiągnięty przez bieżące wykorzystanie.
    ${QUOTA_TYPE}

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

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

    Wartość limitu.
    ${EXPIRY_DATE}

    Data lub godzina wygaśnięcia limitu albo jego zresetowania.

    Jeśli na przykład chcesz otrzymywać powiadomienia, gdy dowolny deweloper osiągnie określony procent liczby transakcji w przypadku dowolnego pakietu w dowolnej aplikacji, możesz edytować szablon tak, aby wyglądał tak:

    ${developer.legalName} has reached a total volume of ${USAGE} on ${ratePlan.monetizationPackage.displayName}. This is ${PERCENT} of the daily/weekly/monthly (state period of limit as appropriate) transaction volume limit of ${QUOTA_LIMIT}.
  4. W razie potrzeby dodaj powiadomienia dla dodatkowych poziomów. W przypadku każdego dodatkowego poziomu kliknij Dodaj. Spowoduje to dodanie do sekcji Powiadomienia na stronie obszarów Poziom, Wyślij e-maila i Szablon e-maila. Możesz dodać maksymalnie 6 poziomów powiadomień. Jeśli na przykład ustawisz powiadomienie na poziomie > 70%, 80%, 90%, 100%, powiadomienie zostanie wysłane po osiągnięciu każdego z tych poziomów.
  5. Po dodaniu wszystkich powiadomień kliknij Zapisz (aby zapisać i opublikować powiadomienia w późniejszym terminie ), Zapisz i opublikuj (aby opublikować teraz) lub Anuluj (aby anulować).

Konfigurowanie powiadomień o limitach za pomocą interfejsu API

Zarabianie udostępnia zestaw szablonów, które zawierają tekst różnych typów powiadomień, w tym powiadomień o limitach oraz powiadomień ad hoc, takich jak ostrzeganie deweloperów o dostępności nowych produktów. Każdy z tych szablonów możesz dostosować do swoich potrzeb. Aby skonfigurować automatyczne powiadomienie o limitach, najpierw edytuj odpowiedni szablon. Następnie określ warunek, który powoduje wysłanie powiadomienia z edytowanego szablonu. Więcej informacji znajdziesz w artykule Konfigurowanie powiadomień za pomocą szablonów powiadomień.

Dalsze kroki

Dowiedz się, jak skonfigurować automatyczne powiadomienia, aby ostrzegać deweloperów o wydarzeniach takich jak nowe produkty, nowe wersje Warunków korzystania z usługi czy nowe plany stawek. Zobacz Konfigurowanie powiadomień za pomocą szablonów powiadomień.