Monetarisierungslimits für API-Proxys erzwingen

Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an.
info

Hängen Sie die Richtlinie „MonetizationLimitsCheck“ an API-Proxys an, um die Monetarisierungslimits zu erzwingen. Die Richtlinie wird insbesondere unter den folgenden Bedingungen ausgelöst:

  • Der Entwickler, der auf die monetarisierte API zugreift, ist nicht registriert oder hat den Preisplan nicht abonniert.
  • Der Entwickler hat das Transaktionsvolumen für den abonnierten Tarif überschritten.
  • Das Guthaben des Prepaid-Kontos oder das Kreditlimit des Postpaid-Kontos des Entwicklers wurde erreicht.

Die Richtlinie „MonetizationLimitsCheck“ soll in Situationen wie den oben aufgeführten einen Fehler auslösen und einen API-Aufruf blockieren. Die Richtlinie erweitert die RaiseFault-Richtlinie (siehe RaiseFault-Richtlinie) und Sie können die zurückgegebene Nachricht anpassen. Die anwendbaren Bedingungen werden aus Geschäftsvariablen abgeleitet.

Richtlinie zur Überprüfung der Monetarisierungslimits über die Benutzeroberfläche anhängen

Um Monetarisierungslimits zu erzwingen, muss die Richtlinie „MonetizationLimitsCheck“ an den Anfrageablauf in API-Proxys angehängt werden, die auf Ihre APIs zugreifen. Die Richtlinie „Prüfung der Monetarisierungslimits“ muss in der Anfrage nach jeder VerifyAPIKey- oder AccessTokenValidation-Richtlinie angehängt werden.

Sie können eine Richtlinie für die Überprüfung der Monetarisierungslimits anhängen, wenn Sie einen API-Proxy erstellen oder nachdem ein API-Proxy erstellt wurde.

Wenn Sie einen API-Proxy erstellen, wie unter Einen einfachen API-Proxy erstellen beschrieben, wird im Assistenten der Bereich „Monetarisierungskonfiguration“ angezeigt, wenn die Monetarisierung installiert ist.

Edge

Klicken Sie auf der Seite Allgemeine Richtlinien des Assistenten das Kästchen Monetarisierungslimits erzwingen an, um eine Richtlinie vom Typ „MonetizationLimitsCheck“ anzuhängen.

Richtlinie „MonetizationLimitsCheck“

Auf der Seite „Zusammenfassung“ des Assistenten werden die Richtlinien zusammengefasst. Die Monetarisierungsrichtlinie muss aufgeführt sein, damit die Richtlinie „MonetizationLimitsCheck“ wie unten beschrieben an den API-Proxy angehängt wird.

Klassisches Edge (Private Cloud)

Klicken Sie auf der Seite Sicherheit des Assistenten das Kästchen Prüfung der Monetarisierungslimits aktivieren an, um eine Richtlinie für die Prüfung der Monetarisierungslimits anzuhängen.

Richtlinie „MonetizationLimitsCheck“

Die Richtlinie „MonetizationLimitsCheck“ wird dem PreFlow der ProxyEndpoint-Anfrage nach der VerifyAPIKey- oder AccessTokenValidation-Richtlinie hinzugefügt, wie in der folgenden Abbildung dargestellt.

So fügen Sie der Richtlinie „MonetizationLimitsCheck“ einen bereits erstellten API-Proxy hinzu:

  1. Klicken Sie im API-Proxy-Editor für den Standard-Proxy-Endpunkt auf PreFlow.
  2. Klicken Sie im Anfrageablauf auf + Schritt.
  3. Wähle in der Kategorie „Vermittlung“ die Option „Prüfung der Monetarisierungslimits“ aus.

  4. Ändern Sie die Felder im Dialogfeld „Schritt hinzufügen“ nach Bedarf und klicken Sie auf Hinzufügen.

Die Richtlinie wird nach einer VerifyAPIKey- oder AccessTokenValidation-Richtlinie an den Anfrageablauf angehängt und für Anfragenachrichten von Client-Apps an den ProxyEndpoint-PreFlow erzwungen.

Weitere Informationen zum Konfigurieren der XML-Datei der MonetizationLimitsCheck-Richtlinie finden Sie unter MonetizationLimitsCheck-Richtlinie.