Egzekwowanie limitów zarabiania na serwerach proxy interfejsu API

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

Dołącz zasadę sprawdzania limitów zarabiania do serwerów proxy interfejsu API, aby egzekwować limity zarabiania. Zasady są egzekwowane w tych sytuacjach:

  • Programista korzystający z interfejsu API, który generuje przychody, nie jest zarejestrowany lub nie ma subskrypcji planu cenowego.
  • Deweloper przekroczył liczbę transakcji w ramach subskrybowanego planu cenowego.
  • Osiągnięto saldo konta przedpłaconego dewelopera lub limit kredytowy konta z płatnościami po wykonaniu usługi.

Zasady sprawdzania limitów zarabiania mają na celu zgłaszanie błędów i blokowanie wywołań interfejsu API w sytuacjach takich jak wymienione powyżej. Zasada ta rozszerza zasadę Raise Fault (patrz Zasada Raise Fault) i umożliwia dostosowanie zwracanego komunikatu. Odpowiednie warunki są określane na podstawie zmiennych biznesowych.

Dołączanie zasady sprawdzania limitów zarabiania za pomocą interfejsu

Aby wymusić limity zarabiania, do przepływu żądań w proxy interfejsów API, które uzyskują dostęp do Twoich interfejsów API, musi być dołączona zasada sprawdzania limitów zarabiania. Zasady Monetization Limits Check powinny być dołączone do żądania po zasadach VerifyAPIKey lub AccessTokenValidation.

Zasadę sprawdzania limitów zarabiania możesz dołączyć podczas tworzenia proxy interfejsu API lub po jego utworzeniu.

Gdy tworzysz serwer proxy interfejsu API zgodnie z opisem w artykule Tworzenie prostego serwera proxy interfejsu API, jeśli masz zainstalowaną funkcję zarabiania, w kreatorze pojawi się sekcja konfiguracji zarabiania.

Edge

Na stronie Typowe zasady kreatora zaznacz pole wyboru Wymuszaj limity zarabiania, aby dołączyć zasadę sprawdzania limitów zarabiania.

Zasady dotyczące sprawdzania limitów zarabiania

Pamiętaj, że na stronie Podsumowanie kreatora zasady są podsumowane. Sprawdź, czy wyświetlają się zasady zarabiania. Oznacza to, że zasady sprawdzania limitów zarabiania zostaną dołączone do serwera proxy interfejsu API, jak opisano poniżej.

Nowy interfejs Edge (chmura prywatna)

  1. Zaloguj się w interfejsie New Edge UI na stronie http://host:3001/edge, gdzie host to adres IP lub nazwa DNS hosta, na którym działa interfejs New Edge UI.
  2. Na pasku nawigacyjnym po lewej stronie wybierz Develop > API Proxies (Programowanie > Proxy interfejsów API) i kliknij +Proxy, aby otworzyć kreator tworzenia proxy.
  3. Na stronie Typowe zasady kreatora zaznacz pole wyboru Wymuszaj limity zarabiania, aby dołączyć zasadę sprawdzania limitów zarabiania.

    Zasady dotyczące sprawdzania limitów zarabiania

  4. Na stronie Podsumowanie kreatora sprawdź, czy wyświetlają się zasady zarabiania. Oznacza to, że do serwera proxy interfejsu API zostaną dołączone zasady sprawdzania limitów zarabiania.

Zasady Monetization Limits Check są dodawane do elementu PreFlow żądania ProxyEndpoint po zasadach VerifyAPIKey lub AccessTokenValidation, jak pokazano na poniższym rysunku.

Aby dodać zasadę Monetization Limits Check do utworzonego już serwera proxy interfejsu API:

  1. W edytorze proxy API kliknij PreFlow w przypadku domyślnego punktu końcowego proxy.
  2. W sekcji Request flow (Przebieg żądania) kliknij +Step (+Krok).
  3. W kategorii Zapośredniczenie wybierz Sprawdzanie limitów zarabiania.

  4. W oknie Dodaj krok zmień pola zgodnie z potrzebami i kliknij Dodaj.

Zasady są dołączane do przepływu żądań po zasadach VerifyAPIKey lub AccessTokenValidation i są egzekwowane w przypadku wiadomości z żądaniami z aplikacji klienckich do przepływu PreFlow w punkcie ProxyEndpoint.

Więcej informacji o konfigurowaniu pliku XML zasad MonetizationLimitsCheck znajdziesz w artykule Zasady MonetizationLimitsCheck.