Configurer les notifications de limite

Vous consultez la documentation Apigee Edge.
Accédez à la documentation**Apigee X**. info

Introduction

Vous pouvez définir des limites liées à la monétisation, comme décrit dans Appliquer des limites de monétisation à l'aide de la règle Monetization Limits Check. Vous pouvez également configurer des notifications automatiques qui alertent les développeurs, et/ou les utilisateurs de votre organisation lorsqu'une limite approche ou est atteinte.

Vous pouvez configurer des notifications automatiques pour les limites personnalisées ainsi que pour les limites implicites. Par exemple, le système définit une limite implicite pour vos développeurs en prépaiement, qui correspond à leur solde prépayé. Vous pouvez configurer des notifications automatiques pour que vos développeurs soient avertis s'ils sont proches ou ont atteint leur réserve prépayée.

Boîte à outils

Vous pouvez configurer des notifications automatiques pour les limites à l'aide de l'interface utilisateur de gestion ou de l'API de monétisation. Si vous utilisez l'interface utilisateur, vous configurez des notifications automatiques sur la page "Notifications".

Si vous utilisez l'API, vous configurez des notifications automatiques pour les limites en modifiant un modèle de notification fourni par la monétisation. Vous spécifiez ensuite la condition qui entraîne l'envoi de la notification fournie par le modèle modifié.

Configurer des notifications de limite à l'aide de l'interface utilisateur

1. Cliquez sur "Ajouter" dans la section "Notifications" de la page "Ajouter une limite". La section "Notification" s'ouvre.

   

2. Sélectionnez un niveau pour la notification. Il s'agit d'un seuil basé sur un nombre absolu ou un pourcentage de la base de la limite. Sélectionnez :
   • Le signe supérieur ou égal (?) ou le signe inférieur ou égal (?) dans le menu déroulant.
   • Un nombre entier (c'est-à-dire sans décimales). Absolu (pour indiquer une valeur numérique) ou Pourcentage pour indiquer une valeur en pourcentage. Pour les limites en pourcentage, assurez-vous toujours de définir la limite sur >, ce qui signifie que la notification est envoyée lorsque le développeur atteint ou dépasse ce niveau de pourcentage.

   Par exemple, si vous définissez une limite de dépenses de 100 $ et que vous définissez la notification sur supérieur ou égal à 90%, la notification sera envoyée lorsque 90% de la limite (90 $) seront atteints ou dépassés.

   

3. Dans le champ "Envoyer un e-mail", sélectionnez un ou plusieurs développeurs, ou un ou plusieurs utilisateurs de votre organisation. La notification sera envoyée aux développeurs ou utilisateurs concernés.

   Destinataires des e-mails : vous ne pouvez envoyer des notifications aux développeurs que si vous définissez une condition de limite de développeur sur "Tous" ou si vous définissez une condition de limite de développeur avec un développeur spécifique. Si vous avez sélectionné "Tous", "Développeur sélectionné (Tous)" s'affiche dans la liste des adresses e-mail. Cela signifie que la monétisation enverra une notification à tous les développeurs concernés. Si vous avez sélectionné un développeur spécifique, "Développeur sélectionné ({developer_id})" s'affiche dans la liste des adresses e-mail (où {developer_id} est l'identifiant du développeur sélectionné). La monétisation n'enverra une notification qu'à ce développeur spécifique.

   Si vous n'avez pas sélectionné la condition de limite de développeur "Tous" ou un développeur spécifique, vous ne verrez pas "Développeur sélectionné (Tous)" dans le champ "Envoyer un e-mail". Toutefois, vous pouvez choisir les utilisateurs de votre organisation que vous souhaitez notifier.

   Vous pouvez ajouter des adresses e-mail pour les utilisateurs de votre organisation en sélectionnant "Utilisateurs de l'organisation" dans l'onglet "Admin".

   Modèles d'e-mail : un modèle d'e-mail s'affiche après que vous avez sélectionné "Développeur sélectionné (Tous)" ou les adresses e-mail des utilisateurs de votre organisation (ou les deux) dans le champ "Envoyer un e-mail" . Le contenu du modèle dépend des éléments suivants :

   • Le niveau de la notification.
   • Si la limite était une limite d'arrêt de l'exécution.
   • Si l'e-mail était destiné aux utilisateurs de l'organisation, aux développeurs ou aux deux.

   Par exemple, si toutes les conditions suivantes sont remplies :

   • La case "Arrêter l'exécution" est cochée.
   • Le niveau de notification est de 100% ou du même montant que la limite.
   • L'e-mail est destiné uniquement aux utilisateurs de l'organisation.

   Le modèle se présente comme suit :

   

   Supposons que le nom de l'entreprise du développeur soit "XYZ company", que la limite de volume de transactions soit définie sur 50 pour un package d'API nommé "X Package" et un produit API nommé "Y Product", et que la date d'expiration soit définie sur le 30 septembre 2013. Le message électronique envoyé se présente comme suit :

   Developer XYZ company has exceeded their transaction volume limit of 50 transactions for X package, Y product. Their API calls will be blocked till 2013-09-30

   Si l'e-mail est destiné à "Développeur sélectionné (Tous)", le modèle se présente comme suit :

   

   Les deux modèles résolvent les variables pertinentes telles que le nom du développeur (le cas échéant), le nom du package (le cas échéant) et le nom du produit (le cas échéant). Vous pouvez modifier le message pour répondre à vos besoins en cliquant sur "Modifier" à gauche du modèle.

   Si la limite concerne "Tous" ou une application spécifique et "Tous" ou un utilisateur spécifique, vous devez également ajouter des variables pour les applications et les utilisateurs au modèle. Pour ce faire :

   • Cliquez sur "Modifier" à gauche du modèle.
   • Ajoutez ${user.name} user, depending on whether the limit is for application and/or user.

   Un modèle modifié pour "Tous" ou une application spécifique est présenté ci-dessous.

   

   Si "Arrêter l'exécution" n'est pas coché ou si le niveau de notification est supérieur ou égal à 100%, le modèle pour un développeur sélectionné se présente comme suit :

   

   Là encore, si la limite concerne "Tous" (ou une application spécifique) ou "Tous" (ou un utilisateur spécifique) , vous devez modifier le modèle, puis ajouter l'application ${application.name} et/ou l'utilisateur ${user.name} en fonction de si la limite concerne une application, un utilisateur ou les deux.

   Variables de modèle : lorsque vous modifiez le message dans un modèle d'e-mail, vous pouvez inclure l'une des variables suivantes.

   Variable	Description
   ${developer.name}	Nom du développeur.
   ${developer.legalName}	Nom de l'entreprise du développeur.
   ${ratePlan.monetizationPackage.displayName}	Nom du package d'API.
   ${application.name}	Nom de l'application.
   ${USER}	Nom de l'utilisateur.
   ${USAGE}	Utilisation actuelle (revenus ou frais totaux, ou volume).
   ${PERCENT}	Pourcentage de la limite atteinte par l'utilisation actuelle.
   ${QUOTA_TYPE}	Type de limite (volume de transactions, limite de dépenses ou exposition aux frais).
   ${QUOTA_UNIT}	Unité de base de la limite : devise (pour une limite de dépenses) ou appels (pour une limite de transactions).
   ${QUOTA_LIMIT}	Montant de la limite.
   ${EXPIRY_DATE}	Date ou heure d'expiration de la limite ou de sa réinitialisation.

   Par exemple, si vous souhaitez être averti lorsqu'un développeur a atteint un certain pourcentage du volume de transactions pour un package sur une application, vous pouvez modifier le modèle comme suit :

   ${developer.legalName} has reached a total volume of ${USAGE} on ${ratePlan.monetizationPackage.displayName}. This is ${PERCENT} of the daily/weekly/monthly (state period of limit as appropriate) transaction volume limit of ${QUOTA_LIMIT}.

4. Ajoutez des notifications si nécessaire pour des niveaux supplémentaires. Pour chaque niveau supplémentaire, cliquez sur "Ajouter". Cela ajoute une zone "Niveau", "Envoyer un e-mail" et "Modèle d'e-mail" à la section "Notifications" de la page. Vous pouvez ajouter jusqu'à six niveaux pour vos notifications. Par exemple, si vous définissez la notification sur > 70%, 80%, 90 % et 100%, une notification sera envoyée lorsque chacun de ces niveaux sera atteint.
5. Une fois toutes les notifications ajoutées, cliquez sur "Enregistrer" (pour enregistrer et publier les notifications à une date ultérieure), "Enregistrer et publier" (pour publier maintenant) ou "Annuler" (pour annuler).

Configurer des notifications de limite à l'aide de l'API

La monétisation fournit un ensemble de modèles qui fournissent le texte de différents types de notifications, y compris les notifications de limite, ainsi que des notifications ad hoc telles que l'alerte des développeurs concernant la disponibilité de nouveaux produits. Vous pouvez personnaliser n'importe lequel de ces modèles en fonction de vos besoins. Pour configurer une notification de limite automatique, commencez par modifier un modèle approprié. Spécifiez ensuite la condition qui entraîne l'envoi de la notification fournie par le modèle modifié. Pour en savoir plus, consultez Configurer des notifications à l'aide de modèles de notification.

Étapes suivantes

Découvrez comment configurer des notifications automatiques pour alerter les développeurs d'événements tels que de nouveaux produits, de nouvelles versions des conditions d'utilisation ou de nouveaux forfaits. Consultez Configurer des notifications à l'aide de modèles de notification.