MonetizationLimitsCheck-Richtlinie

Sie lesen gerade die Apigee Edge -Dokumentation.
Zur Apigee X -Dokumentation. info

Übersicht

Mit der Richtlinie „MonetizationLimitsCheck“ können Sie Monetarisierungslimits für API-Aufrufe festlegen, die vom App-Entwickler ausgeführt werden.

Einige Fälle, in denen die Richtlinie ausgelöst wird:

• Wenn ein App-Entwickler, der auf die monetarisierte API zugreift, kein Abo für das zugehörige API-Produkt erworben hat
• Das Konto des Entwicklers hat ein unzureichendes Guthaben.
• Der Entwickler hat das Limit für das Transaktionsvolumen überschritten.

Informationen zum Verknüpfen der Richtlinie mit Ihrem API-Proxy finden Sie unter Monetarisierungslimits für API-Proxys erzwingen.

Element <MonetizationLimitsCheck>

Gibt die MonetizationLimitsCheck-Richtlinie an.

Die folgende Tabelle enthält eine allgemeine Beschreibung der untergeordneten Elemente von <MonetizationLimitsCheck>:

Das <MonetizationLimitsCheck> Element verwendet die folgende Syntax:

<?xml version="1.0" encoding="UTF-8"?>
<MonetizationLimitsCheck async="false" continueOnError="false" enabled="true" name="POLICY_NAME">
    <DisplayName>DISPLAY_NAME</DisplayName>
    <IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>
    <Variables>
        <Product>VARIABLE_NAME</Product>
    </Variables>
    <FaultResponse>
        <Set>
            <Payload contentType="text/xml">
                <error>
                    <messages>
                        <message>MESSAGE_TEXT</message>
                        <message>MESSAGE_TEXT</message>
                    </messages>
                </error>
            </Payload>
            <StatusCode>HTTP_STATUS</StatusCode>
            <ReasonPhrase>REASON_TEXT</ReasonPhrase>
        </Set>
    </FaultResponse>
</MonetizationLimitsCheck>

<?xml version="1.0" encoding="UTF-8"?>
<MonetizationLimitsCheck async="false" continueOnError="false" enabled="true" name="Monetization-Limits-Check">
    <DisplayName>Monetization Limits Check</DisplayName>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <Variables>
        <Product>myproductvar.name</Product>
    </Variables>
	<FaultResponse>
	        <Set>
	            <Payload contentType="text/xml">
	                <error>
	                    <messages>
	                        <message>Developer has reached usage quota</message>
	                        <message>Is Developer Suspended - {monetizationLimits.isDeveloperSuspended} </message>
	                    </messages>
	                </error>
	            </Payload>
	            <StatusCode>403</StatusCode>
	            <ReasonPhrase>Forbidden</ReasonPhrase>
	        </Set>
	</FaultResponse>
 </MonetizationLimitsCheck>

Dieses Element hat folgende Attribute, die allen Richtlinien gemeinsam sind:

Verweis auf untergeordnetes Element

<DisplayName>

Wird zusätzlich zum Attribut name verwendet, um die Richtlinie im Proxy-Editor der Verwaltungs-UI mit einem anderen, natürlicher klingenden Namen zu versehen.

Das Element <DisplayName> ist für alle Richtlinien gleich.

Das <DisplayName>-Element verwendet die folgende Syntax:

<PolicyElement>
  <DisplayName>policy_display_name</DisplayName>
  ...
</PolicyElement>

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

Das <DisplayName>-Element hat keine Attribute oder untergeordneten Elemente.

<IgnoreUnresolvedVariables>

Bestimmt, ob die Verarbeitung der Richtlinie beendet werden soll, wenn Apigee auf eine nicht aufgelöste Variable stößt.

Setzen Sie den Wert auf true, um nicht aufgelöste Variablen zu ignorieren und die Verarbeitung fortzusetzen; andernfalls false. Der Standardwert ist true.

Das Festlegen von <IgnoreUnresolvedVariables> auf true unterscheidet sich vom Festlegen von continueOnError des Elements <MonetizationLimitsCheck>'s auf true. Wenn Sie continueOnError auf true setzen, ignoriert Apigee nicht nur die Variablenfehler, sondern alle Fehler.

Das <IgnoreUnresolvedVariables> Element verwendet die folgende Syntax:

<IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

<Variables>

Gibt die Ablaufvariablen an, aus denen Sie während der Richtlinienausführung die Entitäts- oder Ressourcennamen abrufen möchten.

Sie können nur das <Product> Element innerhalb des <Variables> Elements angeben. Apigee ruft den API-Produktnamen aus der Ablaufvariablen ab, die im Element <Product> angegeben ist. Wenn Sie das Element <Variables> nicht angeben, ruft Apigee den API-Produktnamen standardmäßig aus der Kontextvariablen apiproduct.name ab. Anhand des API-Produktnamens ruft Apigee den entsprechenden Tarifplan für das Produkt ab und führt die Überprüfung der Monetarisierungslimits durch.

Das <Variables>-Element verwendet die folgende Syntax:

<Variables>
    <Product>VARIABLE_NAME</Product>
</Variables>

<Variables>
    <Product>myproductvar.name</Product>
</Variables>

<Product>

Gibt die Variable mit dem API-Produktnamen an.

Das <Product>-Element verwendet die folgende Syntax:

<Product>VARIABLE_NAME</Product>

<Product>myproductvar.name</Product>

<FaultResponse>

Definiert die Antwortnachricht, die an den anfordernden Client zurückgegeben wird, wenn ein Fehler ausgelöst wird. Sie können die Antwort nach Bedarf anpassen. Weitere Informationen zum Element und allen untergeordneten Elementen finden Sie unter FaultResponse.

Ablaufvariablen

Wenn Sie das Attribut ContinueOnError des Elements <MonetizationLimitsCheck> auf „true“ setzen, wird kein Fehler ausgelöst. In diesem Fall werden die Ablaufvariablen mint.limitsViolated, mint.isDeveloperSuspended, und mint.limitsPolicyError automatisch festgelegt. Diese Variablen können bei Bedarf für die weitere Fehlerbehandlung verwendet werden.