Vous consultez la documentation Apigee Edge.
Accédez à la
documentation Apigee X. info
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, la règle est déclenchée dans les conditions suivantes :
- Le développeur qui accède à l'API monétisée n'est pas enregistré ou n'a pas souscrit d'abonnement au plan tarifaire.
- Le développeur a dépassé le volume de transactions pour le plan tarifaire souscrit.
- Le solde du compte prépayé du développeur ou la limite de crédit post-paiement a été atteint.
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 des situations comme celles listées ci-dessus. La 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'interface utilisateur
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ê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 la création d'un proxy d'API.
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 de 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 associer une règle de vérification des limites de monétisation.
Notez que sur la page Récapitulatif 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.
Classic Edge (Private Cloud)
Sur la page Sécurité de l'assistant, cochez la case Activer la vérification des limites de monétisation pour associer une règle de vérification des limites de monétisation.
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 VerifyAPI Key ou AccessTokenValidation, comme illustré dans la figure suivante.
Pour ajouter la règle de vérification des limites de monétisation à un proxy d'API déjà créé :
- Dans l'éditeur de proxy d'API, cliquez sur PreFlow pour le point de terminaison de proxy par défaut.
- Dans le flux de requêtes, 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 VerifyAPI Key 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.