Appliquer des limites de monétisation dans les proxys d'API

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

Appliquez des limites de monétisation en rattachant des règles aux proxys d'API associés à un produit d'API monétisé, comme décrit dans les sections suivantes.

Ajouter une règle d'authentification

La monétisation Apigee utilise la règle VerifyAPIKey ou VerifyAccessToken pour déterminer si une requête entrante est monétisable en vérifiant le plan tarifaire publié actif.

Associez la règle VerifyAPIKey ou VerifyAccessToken à un proxy d'API de l'une des manières suivantes :

• Lors de la création d'un proxy d'API à l'aide de l'assistant de création de proxy, sélectionnez Clé API ou OAuth 2.0 dans la section Sécurité : Autorisation de la page Règles courantes. Exemple :

  

• Lors du développement d'un proxy d'API, associez la règle VerifyAPIKey ou VerifyAccessToken au flux de requêtes en tant que première règle dans le PreFlow du proxy d'API. Exemple :

  

Pour en savoir plus, consultez :

• Associer une règle à un flux
• Vérifier les jetons d'accès
• Surveiller et déboguer la règle d'authentification à l'aide de l'outil Debug

Appliquer des abonnements développeurs aux produits d'API

Associez la règle MonetizationLimitsCheck aux proxys d'API afin d'appliquer les abonnements développeurs au produit d'API. Plus précisément, la règle est déclenchée si le développeur d'application qui accède à l'API n'a pas souscrit d'abonnement au produit d'API associé. Dans ce cas, la règle MonetizationLimitsCheck génère une erreur et bloque l'appel d'API.

Si aucun plan de taux de monétisation n'existe pour le produit d'API récupéré lors de l'exécution de l'appel du proxy, le produit est considéré comme non monétisé, et la règle MonetizationLimitsCheck ne récupère aucune autre donnée et n'a aucun effet.

Lorsque vous associez la règle MonetizationLimitsCheck à un proxy d'API, les variables de flux mint.limitscheck.* et mint.subscription_* sont renseignées, comme décrit dans Déboguer la règle MonetizationLimitsCheck et dans la documentation de référence sur la variable de flux mint.

Remarque : Pour empêcher la facturation de transactions spécifiques, vous pouvez utiliser la variable de monétisation transactionSuccess. Pour en savoir plus sur l'utilisation de la variable transactionSuccess, consultez Variables de monétisation.

Associez la règle MonetizationLimitsCheck à un proxy d'API de l'une des manières suivantes :

• Lors de la création d'un proxy d'API à l'aide de l'assistant de création de proxy, sélectionnez Appliquer des limites de monétisation sur la page Règles courantes, comme illustré dans la figure suivante.

  

• Lors du développement d'un proxy d'API, associez la règle MonetizationLimitsCheckPolicy au flux de requêtes dans le PreFlow du proxy d'API après la règle VerifyAPIKey ou VerifyAccessToken, comme illustré dans la figure suivante.

  

Pour en savoir plus, consultez :

• Créer un proxy d'API
• Associer une règle à un flux
• Déboguer la règle MonetizationLimitsCheck à l'aide de l'outil Debug
• Règle MonetizationLimitsCheck

Appliquer des quotas de monétisation dans les proxys d'API

Remarque : Si vous ajoutez un quota alors que le produit d'API a déjà été utilisé, le calcul de quota commence à la prochaine transaction monétisée.

Un quota définit le nombre de requêtes autorisées pour un produit d'API sur une période donnée. Pour appliquer des quotas de monétisation, il est recommandé de définir la valeur de quota lors de la création d'un produit d'API.

La définition d'une valeur de quota pour un produit d'API n'applique pas automatiquement de restrictions sur le nombre d'appels pouvant être passés via le produit d'API. Vous devez également ajouter des règles de quota aux proxys d'API référencés par le produit d'API, afin de garantir que la valeur de quota définie au niveau du produit d'API est appliquée.

Associez la règle de quota à un proxy d'API de l'une des manières suivantes :

• Lors de la création d'un proxy d'API à l'aide de l'assistant de création de proxy, sélectionnez Imposer des quotas par application dans la section Quotas de la page Règles courantes, comme illustré dans la figure suivante.

  

• Lors du développement d'un proxy d'API, associez la règle de quota au flux de requêtes dans le PreFlow du proxy d'API après la règle VerifyAPIKey ou VerifyAccessToken, comme illustré dans la figure suivante.

  

Modifiez la règle de quota pour permettre à l'élément <UseQuotaConfigInAPIProduct> d'utiliser la configuration de quota définie au niveau du produit d'API.

Exemple :

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

Notes :

• Vous pouvez définir la configuration <DefaultConfig> par défaut à utiliser si la configuration du quota n'est pas définie dans le produit d'API, mais la configuration de quota définie au niveau du produit d'API est prioritaire.
• Lorsque vous ajoutez l'élément <UseQuotaConfigInAPIProduct> à la règle de quota, Apigee ignore les éléments enfants <Allow>, <Interval> et <TimeUnit> de <Quota>.

Lorsque vous associez la règle de quota à un proxy d'API, les variables de flux ratelimit.* sont renseignées, comme décrit dans Déboguer la règle de quota et dans la documentation de référence sur les variables de flux de la règle de quota.

Pour en savoir plus, consultez :

• Associer une règle à un flux
• Déboguer la règle de quota à l'aide de l'outil Debug
• Règles de quotas