Règle MonétisationLimitsCheck

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X. En savoir plus

Présentation

La règle MonetizationLimitsCheck vous permet d'appliquer des limites de monétisation à vos appels d'API effectués. par le développeur de l'application.

Voici quelques cas où la règle est déclenchée:

• Si le développeur d'une application accédant à l'API monétisée n'a pas souscrit d'abonnement à le produit API associé
• Le solde du compte du développeur est insuffisant.
• Le développeur a dépassé la limite du volume de transactions.

Pour plus d'informations sur l'association de la stratégie à votre proxy d'API, voir Appliquez les limites de monétisation sur les proxys d'API.

Élément <MonetizationLimitsCheck>

Spécifie la règle MonetizationLimitsCheck.

Le tableau suivant fournit une description détaillée des éléments enfants de <MonetizationLimitsCheck> :

L'élément <MonetizationLimitsCheck> utilise la syntaxe suivante :

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

Cet élément possède les attributs suivants qui sont communs à toutes les règles :

Référence d'élément enfant

<DisplayName>

Utilisez-le, en plus de l'attribut name, pour appliquer un libellé à la règle dans l'éditeur de proxys de l'interface de gestion en utilisant un nom différent et plus naturel.

L'élément <DisplayName> est commun à toutes les règles.

L'élément <DisplayName> utilise la syntaxe suivante :

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

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

L'élément <DisplayName> ne comporte aucun attribut ni élément enfant.

<IgnoreUnresolvedVariables>

Détermine si le traitement de la stratégie doit s'arrêter lorsqu'Apigee rencontre une variable non résolue.

Pour ignorer les variables non résolues et poursuivre le traitement, définissez la valeur sur true. sinon false. La valeur par défaut est true.

Définir <IgnoreUnresolvedVariables> sur true n'est pas la même chose que définir l'élément <MonetizationLimitsCheck> De continueOnError à true. Si vous définissez continueOnError sur true, Apigee ignore pas seulement les erreurs de variable, mais toutes les erreurs.

L'élément <IgnoreUnresolvedVariables> utilise la syntaxe suivante :

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

<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

<Variables>

Spécifie les variables de flux à partir desquelles vous souhaitez extraire les d'entité ou de ressource lors de l'exécution de la stratégie.

Vous ne pouvez spécifier que l'élément <Product> dans l'élément <Variables>. Apigee obtient le nom du produit d'API à partir de la variable de flux spécifiée dans l'élément <Product>. Si vous ne spécifiez pas l'élément <Variables>, Apigee obtient par défaut le nom du produit d'API à partir du Variable de contexte apiproduct.name. En utilisant le nom du produit d'API, Apigee obtient le plan tarifaire correspondant pour le produit et vérifie les limites de monétisation.

L'élément <Variables> utilise la syntaxe suivante :

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

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

<Product>

Spécifie la variable ayant le nom de produit d'API.

L'élément <Product> utilise la syntaxe suivante :

<Product>VARIABLE_NAME</Product>

<Product>myproductvar.name</Product>

<FaultResponse>

Définit le message de réponse renvoyé au client demandeur si une erreur est identifiée. Vous pouvez personnaliser la réponse en fonction de vos besoins. Pour en savoir plus sur la et tous ses éléments enfants, consultez FaultResponse.

Variables de flux

Si vous définissez la valeur de l'élément <MonetizationLimitsCheck> ContinueOnError sur "true", aucune erreur n'est générée. Dans ce cas, variables de flux, mint.limitsViolated, mint.isDeveloperSuspended et mint.limitsPolicyError sont automatiquement définis. Ces variables peuvent être utilisées pour effectuer un traitement supplémentaire des exceptions si nécessaire.