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.

Cette page explique comment appliquer des limites de monétisation en associant des règles à des proxys d'API dans un produit d'API monétisé.

Ajouter une règle d'authentification

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

Associez la règle au proxy d'API à l'aide de l'interface utilisateur ou de l'API Apigee. Pour en savoir plus sur la modification d'un proxy, consultez Modifier un proxy d'API.

Voir également :

Appliquer des abonnements développeurs aux produits d'API

Associez la règle MonetizationLimitsCheck aux proxys d'API pour appliquer les abonnements développeurs au produit 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é, la règle MonetizationLimitsCheck ne récupère aucune autre donnée et n'a aucun effet.
  • Si un plan tarifaire est trouvé, mais qu'aucun abonnement n'est trouvé pour le développeur d'API, la règle MonetizationLimitsCheck génère une erreur et bloque l'appel d'API.

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 la documentation de référence sur les variables de flux mint.

Pour en savoir plus, consultez les pages suivantes :

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

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.

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>

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

Pour en savoir plus, consultez les pages suivantes :