Vous consultez la documentation Apigee Edge.
Accédez à la documentation Apigee X.
Associez la règle de vérification des limites de monétisation aux proxys d'API pour appliquer des limites de monétisation. Plus précisément, le règlement est déclenché dans les conditions suivantes :
- Le développeur qui accède à l'API monétisée n'est pas enregistré ou ne s'est pas abonné au plan tarifaire.
- Le développeur a dépassé le volume de transactions autorisé par le forfait auquel il est abonné.
- Le solde du compte prépayé ou la limite de crédit du compte post-payé du développeur ont été atteints.
La règle de vérification des limites de monétisation est conçue pour générer une erreur et bloquer un appel d'API dans les situations listées ci-dessus. Cette règle étend la règle RaiseFault (voir Règle RaiseFault) et vous permet de personnaliser le message renvoyé. Les conditions applicables sont dérivées des variables d'entreprise.
Associer une règle de vérification des limites de monétisation à l'aide de l'UI
Pour appliquer des limites de monétisation, une règle de vérification des limites de monétisation doit être associée au flux de requête dans les proxys d'API qui accèdent à vos API. La règle de vérification des limites de monétisation doit être associée après toute règle VerifyAPIKey ou AccessTokenValidation dans la requête.
Vous pouvez associer une règle de vérification des limites de monétisation lorsque vous créez un proxy d'API ou après sa création.
Lorsque vous créez un proxy d'API, comme décrit dans Créer un proxy d'API simple, si la monétisation est installée, la section "Configuration de la monétisation" s'affiche dans l'assistant.
Edge
Sur la page Règles courantes de l'assistant, cochez la case Appliquer des limites de monétisation pour associer une règle de vérification des limites de monétisation.
Notez que les règles sont résumées sur la page "Récapitulatif" de l'assistant. Assurez-vous que la règle de monétisation est listée, ce qui indique que la règle de vérification des limites de monétisation sera associée au proxy d'API, comme décrit ci-dessous.
Nouvelle interface utilisateur Edge (cloud privé)
- Connectez-vous à la nouvelle interface utilisateur Edge à l'adresse
http://host:3001/edge, où host correspond à l'adresse IP ou au nom DNS de l'hôte exécutant la nouvelle interface utilisateur Edge. - Sélectionnez Développer > Proxys d'API dans la barre de navigation de gauche, puis cliquez sur + Proxy pour ouvrir l'assistant Créer un proxy.
- Sur la page Règles courantes de l'assistant, cochez la case Appliquer des limites de monétisation pour associer une règle de vérification des limites de monétisation.
- Sur la page Résumé de l'assistant, assurez-vous que la règle de monétisation est listée, ce qui indique que la règle de vérification des limites de monétisation sera associée au proxy d'API.
La règle de vérification des limites de monétisation est ajoutée au PreFlow de la requête ProxyEndpoint, après la règle VerifyAPIKey ou AccessTokenValidation, comme illustré dans la figure suivante.
Pour ajouter la règle MonetizationLimitsCheck à un proxy d'API déjà créé :
- Dans l'éditeur de proxy d'API, cliquez sur PreFlow pour le point de terminaison du proxy par défaut.
- Dans le flux de requête, cliquez sur + Étape.
- Sélectionnez "Vérification des limites de monétisation" dans la catégorie "Médiation".
- Modifiez les champs de la boîte de dialogue "Ajouter une étape" comme vous le souhaitez, puis cliquez sur Ajouter.
La règle est associée au flux de requêtes après toute règle VerifyAPIKey ou AccessTokenValidation. Elle sera appliquée aux messages de requête des applications clientes au PreFlow ProxyEndpoint.
Pour en savoir plus sur la configuration du fichier XML de la règle MonetizationLimitsCheck, consultez Règle MonetizationLimitsCheck.