Egzekwowanie limitów zarabiania na serwerach proxy interfejsu API

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

Dołącz zasadę sprawdzania limitów zarabiania do serwerów proxy interfejsu API, aby egzekwować limity zarabiania. Zasada jest wywoływana w tych przypadkach:

  • Deweloper, który uzyskuje dostęp do interfejsu API z włączoną monetyzacją, nie jest zarejestrowany lub nie subskrybuje planu taryfowego.
  • Deweloper przekroczył limit transakcji w ramach subskrybowanego planu taryfowego.
  • Deweloper osiągnął limit środków na koncie przedpłaconym lub limit kredytowy na koncie z płatnością odroczoną.

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

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

Aby egzekwować limity zarabiania, do przepływu żądania w serwerach proxy interfejsu API, które uzyskują dostęp do Twoich interfejsów API, należy dołączyć zasadę sprawdzania limitów zarabiania. Zasadę sprawdzania limitów zarabiania należy dołączyć po zasadzie VerifyAPIKey lub AccessTokenValidation w żądaniu.

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

Podczas tworzenia serwera proxy interfejsu API, zgodnie z opisem w artykule Tworzenie prostego serwera proxy interfejsu API, jeśli zainstalowana jest monetyzacja, w kreatorze pojawi się sekcja Konfiguracja zarabiania.

Edge

Aby dołączyć zasadę sprawdzania limitów zarabiania, na stronie kreatora Typowe zasady zaznacz pole wyboru Egzekwuj limity zarabiania.

Zasady dotyczące sprawdzania limitów zarabiania

Na stronie Podsumowanie kreatora znajdziesz podsumowanie zasad. Upewnij się, że na liście znajduje się zasada zarabiania, co oznacza, że zasada sprawdzania limitów zarabiania zostanie dołączona do serwera proxy interfejsu API zgodnie z opisem poniżej.

Classic Edge (Private Cloud)

Aby dołączyć zasadę sprawdzania limitów zarabiania, na stronie kreatora Zabezpieczenia zaznacz pole wyboru Włącz sprawdzanie limitów zarabiania.

Zasady dotyczące sprawdzania limitów zarabiania

Zasada sprawdzania limitów zarabiania jest dodawana do przepływu PreFlow żądania ProxyEndpoint po zasadzie VerifyAPIKey lub AccessTokenValidation, jak pokazano na ilustracji poniżej.

Aby dodać zasadę sprawdzania limitów zarabiania do utworzonego już serwera proxy interfejsu API:

  1. W edytorze serwera proxy interfejsu API kliknij PreFlow domyślnego punktu końcowego serwera proxy.
  2. W przepływie żądania kliknij +Krok.
  3. W kategorii Mediacja wybierz Sprawdzanie limitów zarabiania.

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

Zasada jest dołączana do przepływu żądania po zasadzie VerifyAPIKey lub AccessTokenValidation i będzie egzekwowana w przypadku wiadomości z żądaniami z aplikacji klienckich do przepływu PreFlow ProxyEndpoint.

Więcej informacji o konfigurowaniu pliku XML zasady MonetizationLimitsCheck, znajdziesz w artykule Zasada MonetizationLimitsCheck.