Appliquer les limites de monétisation sur les proxys d'API

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X.
en savoir plus

Associez la règle de vérification des limites de monétisation aux proxys d'API pour appliquer les 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'est pas abonné au plan tarifaire.
  • Le développeur a dépassé le volume de transactions pour le plan tarifaire abonné.
  • Le solde de compte prépayé du développeur ou la limite de crédit post-payée a été atteint.

La règle "Vérification des limites de monétisation" est conçue pour signaler une erreur et bloquer un appel d'API dans les situations énumérées ci-dessus. La règle étend la stratégie Augmente les erreurs (voir Stratégie Augmente les erreurs). Vous pouvez personnaliser le message renvoyé. Les conditions applicables sont issues de variables métier.

Associer une règle de vérification des limites de monétisation à l'aide de l'UI

Pour appliquer les limites de monétisation, une règle de vérification des limites de monétisation doit être jointe 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 jointe après chaque règle VerifyAPIKey ou AccessTokenValidation dans la requête.

Vous pouvez joindre 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.

Périphérie

Sur la page Règles communes de l'assistant, cochez la case Appliquer les limites de monétisation pour joindre une règle de vérification des limites de monétisation.

Règlement sur la vérification des limites de monétisation

Notez que la page "Summary" (Résumé) de l'assistant présente un récapitulatif des règles. Assurez-vous que les règles de monétisation sont listées, indiquant 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 (cloud privé)

Sur la page Sécurité de l'assistant, cochez la case Enable Monetization Limits Check (Activer les limites de monétisation) pour joindre une règle de vérification des limites de monétisation.

Règlement sur la 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 le montre la figure suivante.

Pour ajouter la règle "Vérification des limites de monétisation" à un proxy d'API déjà créé:

  1. Dans l'éditeur de proxys d'API, cliquez sur PreFlow comme point de terminaison du proxy par défaut.
  2. Dans le flux de requête, cliquez sur + Étape.
  3. Sélectionnez "Vérification des limites de monétisation" dans la catégorie "Médiation".

  4. Si nécessaire, 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ête après une règle VerifyAPI Key ou AccessTokenValidation. Elle est appliquée aux messages de demande envoyés par les applications clientes au PreFlow ProxyEndpoint.

Pour en savoir plus sur la configuration du fichier XML de la règle MonetizationLimitsCheck, consultez la Règle MonetizationLimitsCheck.