Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info
Associez la règle MonetizationLimitsCheck aux proxys d'API pour appliquer des limites de monétisation. Plus précisément, la règle se déclenche 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 pour le forfait souscrit.
- Le solde du compte prépayé ou la limite de crédit postpayé du développeur a été atteint.
La règle MonetizationLimitsCheck est conçue pour générer une erreur et bloquer un appel d'API dans des situations comme celles listées ci-dessus. Cette règle étend la règle Raise Fault (voir Règle Raise Fault), et vous pouvez personnaliser le message renvoyé. Les conditions applicables sont dérivées de variables métier.
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 MonetizationLimitsCheck doit être associée au flux de requêtes 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 la section 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 communes de l'assistant, cochez la case Appliquer des limites de monétisation pour joindre une règle MonetizationLimitsCheck.
Notez que sur la page "Résumé" de l'assistant, les règles sont résumées. 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.
Edge classique (cloud privé)
Sur la page Sécurité de l'assistant, cochez la case Activer la vérification des limites de monétisation pour joindre une règle de vérification des limites de monétisation.
La règle MonetizationLimitsCheck 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 proxy par défaut.
- Dans le flux de requête, cliquez sur + Step (+ É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 "Add Step" (Ajouter une étape), puis cliquez sur Add (Ajouter).
La règle est associée au flux de requêtes après toute règle VerifyAPIKey ou AccessTokenValidation, et 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 la section Règle MonetizationLimitsCheck.