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électionnezAPI Key (Clé API) ou OAuth 2.0 dans la section Security: Authorization (Sécurité : Autorisation) de la page Common policies (Règles courantes). Exemple :

    Page "Règles courantes" de l'assistant de création de proxy avec l'option "API Key" (Clé API) sélectionnée

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

    Onglet "Développeur" dans l'éditeur de proxy d'API indiquant la règle VerifyAPIKey associée au PreFlow

Pour en savoir plus, consultez les pages suivantes :

Appliquer des abonnements développeurs aux produits d'API

Associez la règle MonetizationLimitsCheck aux proxys d'API afin d'appliquer les abonnements de développeur au produit d'API. Plus précisément, la règle est déclenchée si le développeur de l'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é, 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 la section Déboguer la règle MonetizationLimitsCheck et la documentation de référence sur la variable de flux mint.

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 Enforce monetization limits (Appliquer des limites de monétisation) sur la page Common policies (Règles courantes), comme illustré dans la figure suivante.

    Page des règles communes de l'assistant de création de proxy avec l'option "Appliquer des vérifications de limites" sélectionnée

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

    Onglet "développeur" dans l'éditeur de proxy d'API indiquant la règle MonetizationLimitsCheck associée au PreFlow après la règle VerifyAPI

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 l'application de la valeur de quota définie au niveau du produit d'API.

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électionnezImpose quotas per app (Imposer des quotas par application) dans la section Quotas de la page Common policies (Règles courantes), comme illustré dans la figure suivante.

    Page "Règles courantes" de l'assistant de création de proxy avec l'option "Impose quotas per app" (Imposer des quotas par application) sélectionnée

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

    Onglet "Developer" (Développeur) dans l'éditeur de proxy d'API montrant les règles de quota associées au PreFlow

Modifiez la règle de quota pour permettre à l'élément <UseQuotaConfigInAPIProduct> d'utiliser la configuration du 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 :