Règle MonétisationLimitsCheck

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

Présentation

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

Voici certains des cas de déclenchement de la règle:

• Si un développeur d'applications qui accède à l'API monétisée n'a pas souscrit d'abonnement au produit d'API associé
• Le solde du compte du développeur est insuffisant.
• Le développeur a dépassé la limite de volume de transactions.

Pour savoir comment associer la règle à votre proxy d'API, consultez Appliquer des 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 règle doit s'arrêter lorsqu'Apigee rencontre une variable non résolue.

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

La définition de <IgnoreUnresolvedVariables> sur true est différente de celle de l'élément continueOnError de l'élément <MonetizationLimitsCheck> sur true. Si vous définissez continueOnError sur true, Apigee ignore non seulement les erreurs de variable, mais également 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 noms 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 de produit d'API à partir de la variable de contexte apiproduct.name. Grâce à ce nom, Apigee obtient le plan tarifaire correspondant au 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 portant le nom de produit 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 en cas d'erreur. Vous pouvez personnaliser les messages de réponse en fonction de vos besoins. Pour en savoir plus sur l'élément et sur tous ses éléments enfants, consultez FaultResponse.

Variables de flux

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