Monetarisierungslimits in API-Proxys erzwingen

Diese Seite gilt für Apigee und Apigee Hybrid.

Apigee Edge-Dokumentation aufrufen

Auf dieser Seite wird beschrieben, wie Sie Monetarisierungslimits erzwingen, indem Sie Richtlinien an API-Proxys in einem monetarisierten API-Produkt anhängen.

Authentifizierungsrichtlinie hinzufügen

Die Apigee-Monetarisierung verwendet die VerifyAPIKey-Richtlinie oder den VerifyAccessToken-Vorgang der OAuth2-Richtlinie, um festzustellen, ob eine eingehende Anfrage monetarisierbar ist. Dazu wird das aktive veröffentlichte Tarifpaket geprüft.

Hängen Sie die Richtlinie mithilfe der Apigee-Benutzeroberfläche oder der API an den API-Proxy an. Informationen zum Bearbeiten eines Proxys finden Sie unter API-Proxy bearbeiten.

Weitere Informationen

Entwicklerabos für API-Produkte erzwingen

Hängen Sie die Richtlinie „MonetizationLimitsCheck“ an API-Proxys an, um Entwicklerabos für das API-Produkt zu erzwingen:

  • 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 ein Tarifpaket, aber kein Abo für den API-Entwickler gefunden wird, löst die Richtlinie „MonetizationLimitsCheck“ einen Fehler aus und blockiert den API-Aufruf.

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 Referenz zu Mint-Ablaufvariablen beschrieben.

Weitere Informationen finden Sie unter:

Monetarisierungskontingente in API-Proxys erzwingen

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.

Bearbeiten Sie die Kontingentrichtlinie, um das Element <UseQuotaConfigInAPIProduct> zu aktivieren und die auf API-Produktebene definierte Kontingentkonfiguration zu verwenden.

Beispiel:

<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.

Weitere Informationen finden Sie unter: