Diese Seite gilt für Apigee und Apigee Hybrid.
Apigee Edge-Dokumentation aufrufen
Erzwingen Sie Monetarisierungslimits, indem Sie Richtlinien an API-Proxys anhängen, die mit einem monetarisierten API-Produkt verknüpft sind, wie in den folgenden Abschnitten beschrieben.
Authentifizierungsrichtlinie hinzufügen
Die Apigee-Monetarisierung verwendet die VerifyAPIKey- oder VerifyAccessToken-Richtlinie, um festzustellen, ob eine eingehende Anfrage monetarisierbar ist. Dazu wird das aktive veröffentlichte Tarifpaket geprüft.
Hängen Sie die VerifyAPIKey-Richtlinie oder die VerifyAccessToken-Richtlinie auf eine der folgenden Arten an einen API-Proxy an:
-
Wenn Sie API-Proxy mit dem Assistent "Proxy erstellen" erstellen, wählen Sie den API-Schlüssel oder OAuth 2.0 im Abschnitt Sicherheit: Autorisierung auf der Seite Allgemeine Richtlinien aus. Beispiele:
-
Hängen Sie bei der Entwicklung eines API-Proxys die VerifyAPIKey-Richtlinie oder die VerifyAccessToken-Richtlinie an den Anfrageablauf als erste Richtlinie im API-Proxy-PreFlow an. Beispiele:
Weitere Informationen finden Sie unter:
- Richtlinie zu einem Ablauf hinzufügen
- Zugriffstoken prüfen
- Monitoring und Debugging der Authentifizierungsrichtlinie mit Debug
Entwicklerabos für API-Produkte erzwingen
Verknüpfen Sie die Richtlinie "MonetizationLimitsCheck" an API-Proxys, um Entwicklerabos für das API-Produkt zu erzwingen. Insbesondere wird die Richtlinie ausgelöst, wenn der App-Entwickler, der auf die API zugreift, kein Abo für das zugehörige API-Produkt erworben hat. In diesem Fall löst die Richtlinie "MonetizationLimitsCheck" einen Fehler aus und blockiert den API-Aufruf.
Wenn für das API-Produkt, das während der Proxy-Aufrufausführung abgerufen wird, kein Monetarisierungsplan vorhanden ist, wird das Produkt als nicht monetarisiert betrachtet, die Richtlinie "MonetizationLimitsCheck" ruft keine weiteren Daten ab und die Richtlinie hat keine Auswirkungen.
Wenn Sie die Richtlinie "MonetizationLimitsCheck" an einen API-Proxy anhängen, werden die Ablaufvariablen mint.limitscheck.*
und mint.subscription_*
ausgefüllt, wie unter Debugging der Richtlinie "MonetizationLimitsCheck" und in der mint-Ablaufvariablenreferenz beschrieben.
Hängen Sie die Richtlinie "MonetizationLimitsCheck" auf eine der folgenden Arten an einen API-Proxy an:
-
Wenn Sie mit dem Assistenten zum Erstellen eines Proxys einen API-Proxy erstellen, wählen Sie auf der Seite Allgemeine Richtlinien die Option Monetarisierungslimits erzwingen aus, wie in der folgenden Abbildung dargestellt.
-
Hängen Sie bei der Entwicklung eines API-Proxys die Richtlinie "MonetizationLimitsCheckPolicy" an den Anfrageablauf im API-Proxy-PreFlow nach der VerifyAPIKey- oder VerifyAccessToken-Richtlinie an, wie in der folgenden Abbildung dargestellt.
Weitere Informationen finden Sie unter:
- API-Proxy erstellen
- Richtlinie zu einem Ablauf hinzufügen
- Debugging der Richtlinie "MonetizationLimitsCheck" mit Debug
- MonetizationLimitsCheck-Richtlinie
Monetarisierungskontingente in API-Proxys durchsetzen
Ein Kontingent definiert die Anzahl der Anfragen, die für ein API-Produkt in einem bestimmten Zeitraum zulässig sind. Zur Durchsetzung von Kontingenten für die Monetarisierung empfiehlt es sich, den Kontingentwert beim Erstellen eines API-Produkts festzulegen.
Das Definieren eines Kontingentwerts für ein API-Produkt erzwingt nicht automatisch Einschränkungen für die Anzahl der Aufrufe, die über das API-Produkt erfolgen können. Sie müssen außerdem API-Proxys hinzufügen, die von dem API-Produkt referenziert werden, um sicherzustellen, dass der auf API-Produktebene definierte Kontingentwert erzwungen wird.
Hängen Sie die Quota-Richtlinie auf eine der folgenden Arten an einen API-Proxy an:
-
Wenn Sie mit dem Assistenten zum Erstellen eines Proxys einen API-Proxy erstellen, wählen Sie Kontingente pro Anwendung festlegen im Abschnitt Kontingente auf der Seite Allgemeine Richtlinien aus, wie in der folgenden Abbildung dargestellt.
- Hängen Sie bei der Entwicklung eines API-Proxys die Kontingentrichtlinie an den Anfrageablauf im API-Proxy-PreFlow nach der VerifyAPIKey- oder VerifyAccessToken-Richtlinie an, wie in der folgenden Abbildung dargestellt.
Bearbeiten Sie die Kontingentrichtlinie, um das Element <UseQuotaConfigInAPIProduct> zu aktivieren und die auf API-Produktebene definierte Kontingentkonfiguration zu verwenden.
Beispiele:
<Quota continueOnError="false" enabled="true" name="impose-quota"> <DisplayName>Impose Quota</DisplayName> <UseQuotaConfigInAPIProduct stepName="verify-api-key"> <DefaultConfig> <Allow>10000</Allow> <Interval>1</Interval> <TimeUnit>week</TimeUnit> </DefaultConfig> </UseQuotaConfigInAPIProduct> <Distributed>true</Distributed> <Synchronous>true</Synchronous> <StartTime>2021-01-01 12:00:00</StartTime> </Quota>
Wenn Sie die Kontingentrichtlinie an einen API-Proxy anhängen, werden die ratelimit.*
-Ablaufvariablen ausgefüllt, wie unter Debugging der Kontingentrichtlinie und in der Referenz zu den Ablaufvariablen der Kontingentrichtlinie beschrieben.
- Richtlinie zu einem Ablauf hinzufügen
- Debugging der Kontingentrichtlinie mit Debug
- Kontingentrichtlinie