Configurer les notifications de limite

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

Introduction

Vous pouvez définir des limites liées à la monétisation en suivant les instructions décrites dans Appliquer des limites de monétisation à l'aide de la règle "Vérification des limites de monétisation". Vous pouvez également configurer des notifications automatiques qui avertissent les développeurs et/ou les utilisateurs de votre organisation lorsqu'une limite s'approche ou est atteinte.

Vous pouvez configurer des notifications automatiques pour les limites personnalisées et implicites. Par exemple, le système définit une limite implicite pour vos développeurs prépayés, qui correspond à leur solde prépayé. Vous pouvez configurer des notifications automatiques afin d'informer vos développeurs s'ils approchent ou s'ils 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 pouvez configurer 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 les notifications de limite à l'aide de l'UI

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

   

2. Sélectionnez le niveau de la notification. Il s'agit d'un seuil basé sur un nombre absolu ou sur un pourcentage de la limite. Sélectionnez l'une de ces options :
   • Signe supérieur ou égal à (?) ou inférieur ou égal à (?) dans le menu déroulant.
   • Nombre entier (sans décimales). Absolu (pour indiquer une valeur numérique) ou pourcentage pour indiquer une valeur en pourcentage. Pour les limites de 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épense de 100 $et que vous définissez une notification supérieure ou égale à 90%, la notification est envoyée lorsque 90% de la limite (90 $) est atteinte ou dépassée.

   

3. Dans le champ "Envoyer un e-mail", sélectionnez un ou plusieurs développeurs, ou sélectionnez un ou plusieurs utilisateurs de votre organisation. Une 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 pour les développeurs sur "Toutes" ou une condition de limite pour les développeurs avec un développeur spécifique. Si vous avez sélectionné "Toutes", "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})" apparaît dans la liste des adresses e-mail ({developer_id} étant l'identification du développeur sélectionné). La monétisation enverra une notification uniquement au développeur concerné.

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

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

   Modèles d'e-mail:vous verrez un modèle d'e-mail après avoir sélectionné "Développeur sélectionné (tous)" dans le champ "Envoyer un e-mail" ou les adresses e-mail des utilisateurs de votre organisation (ou les deux).Les éléments affichés dans le modèle dépendent des éléments suivants:

   • Niveau de la notification.
   • Indique si la limite était une limite d'arrêt d'exécution.
   • Indique 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 "Interrompre l'exécution" est cochée.
   • Le niveau de notification est égal ou égal à la limite.
   • Cet e-mail est destiné aux utilisateurs de l'organisation uniquement.

   Le modèle se présente comme suit:

   

   Supposons que le nom de l'entreprise du développeur soit "Entreprise XYZ". La limite du volume de transactions est fixée à 50 pour un package d'API nommé "X Package" et un produit d'API nommé "Y Product", et que la date d'expiration est définie au 30 septembre 2013. L'e-mail 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 s'affiche 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 en fonction de vos besoins en cliquant sur "Modifier" à gauche du modèle.

   Si la limite est définie sur "Toutes" ou pour une application spécifique, et sur "Toutes" ou un utilisateur spécifique, vous devez également ajouter des variables au modèle pour l'application ou les utilisateurs. Pour ce faire, procédez comme suit:

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

   Vous trouverez ci-dessous un modèle modifié pour "Toutes" ou pour une application spécifique.

   

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

   

   Là encore, si la limite est définie sur "Toutes" (ou une application spécifique) ou "N'importe quel utilisateur" (ou pour un utilisateur spécifique), vous devez modifier le modèle, puis ajouter l'application ${application.name} et/ou l'utilisateur ${user.name}, selon que la limite s'applique à une application, à un utilisateur ou aux 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 (total des revenus ou frais 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 des frais).
   ${QUOTA_UNIT}	Unité de base de la limite: devise (pour une limite de dépense) ou appels (pour une limite de transaction).
   ${QUOTA_LIMIT}	Montant de la limite.
   ${EXPIRY_DATE}	Date ou heure d'expiration de la limite, ou de réinitialisation.

   Par exemple, si vous souhaitez être averti lorsqu'un développeur a atteint un certain pourcentage du volume de transactions pour n'importe quel package d'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 pour les niveaux supplémentaires si nécessaire. Pour chaque niveau supplémentaire, cliquez sur "Ajouter". Les sections "Niveau", "Envoyer un e-mail" et "Modèle d'e-mail" sont ajoutées à la section "Notifications" de la page. Vous pouvez ajouter jusqu'à six niveaux de notifications. Par exemple, si vous définissez la notification sur > 70%, 80%, 90%, 100%, une notification est envoyée lorsque chacun de ces niveaux est atteint.
5. Après avoir ajouté toutes les notifications, cliquez sur "Enregistrer" (pour les enregistrer et les publier ultérieurement), sur "Enregistrer et publier" (pour publier maintenant) ou sur "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 et les notifications ponctuelles, par exemple pour alerter les développeurs de la disponibilité de nouveaux produits. Vous pouvez adapter chacun de ces modèles à vos besoins. Pour configurer une notification de limite automatique, commencez par modifier le 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 afin d'alerter les développeurs sur des événements tels que de nouveaux produits, de nouvelles versions des conditions d'utilisation ou de nouveaux plans tarifaires. Consultez la section Configurer des notifications à l'aide de modèles de notification.