Egzekwowanie limitów zarabiania na serwerach proxy interfejsu API

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X.
Informacje

Dołącz zasadę sprawdzania limitów zarabiania do serwerów proxy interfejsu API, aby egzekwować limity zarabiania. Zasada jest wyzwalana w następujących sytuacjach:

  • Deweloper korzystający z interfejsu API zarabiania nie jest zarejestrowany lub nie ma subskrypcji abonamentu.
  • Deweloper przekroczył liczbę transakcji w ramach subskrybowanego abonamentu.
  • Osiągnięto limit środków na koncie opłacanych z góry lub po wykonaniu usługi.

Zasada sprawdzania limitów zarabiania ma na celu zgłaszanie błędów i blokowanie wywołania interfejsu API w sytuacjach opisanych powyżej. Zasada rozszerza zasadę Zgłaszanie błędów (zobacz Zgłaszanie zasady błędu) i umożliwia dostosowanie zwracanego komunikatu. Odpowiednie warunki są określane na podstawie zmiennych biznesowych.

Dołączanie zasad dotyczących sprawdzania limitów zarabiania za pomocą interfejsu

Aby egzekwować limity zarabiania, do przepływu żądań na serwerach proxy API, które mają dostęp do Twoich interfejsów API, musisz dołączyć zasadę sprawdzania limitów zarabiania. Zasadę sprawdzania limitów zarabiania należy dołączyć po każdej zasadzie ConfirmAPIKey lub AccessTokenValidation w żądaniu.

Możesz dołączyć zasadę sprawdzania limitów zarabiania podczas tworzenia serwera proxy interfejsu API lub po utworzeniu takiego serwera.

Gdy utworzysz serwer proxy interfejsu API zgodnie z opisem w sekcji Tworzenie prostego serwera proxy interfejsu API, jeśli funkcja zarabiania jest zainstalowana, w kreatorze pojawi się sekcja Konfiguracja zarabiania.

Edge

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

Zasady sprawdzania limitów zarabiania

Pamiętaj, że na stronie podsumowania kreatora znajduje się podsumowanie zasad. Sprawdź, czy jest wymieniona zasada zarabiania wskazująca, że do serwera proxy interfejsu API zostanie dołączona zasada sprawdzania limitów zarabiania, jak opisano poniżej.

Klasyczna wersja Edge (Private Cloud)

Na stronie Zabezpieczenia w kreatorze zaznacz pole wyboru Włącz limity zarabiania, aby dołączyć zasadę sprawdzania limitów zarabiania.

Zasady sprawdzania limitów zarabiania

Zasada sprawdzania limitów zarabiania jest dodawana do żądania PreFlow ProxyEndpoint po zasadzie weryfikacji klucza lub AccessTokenValidation w sposób pokazany na tej ilustracji.

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

  1. W edytorze serwera proxy interfejsu API kliknij PreFlow dla domyślnego punktu końcowego serwera proxy.
  2. W procesie żądania kliknij +Krok.
  3. Wybierz Sprawdzanie limitów zarabiania w kategorii Zapośredniczenie.

  4. Odpowiednio zmodyfikuj wartości pól w oknie Dodaj krok i kliknij Dodaj.

Zasada jest dołączana do przepływu żądania po dowolnej zasadzie weryfikacji klucza API lub zasady AccessTokenValidation i jest egzekwowana w przypadku wiadomości wysyłanych z aplikacji klienckich do obiektu ProxyEndpoint PreFlow.

Więcej informacji o konfigurowaniu pliku XML zasad MonetizationLimitsCheck znajdziesz w opisie zasady MonetizationLimitsCheck.