Les notifications de monétisation ne fonctionnent pas

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X.
En savoir plus

Symptôme

Les notifications de monétisation ne fonctionnent pas. Par conséquent, aucun e-mail n'est envoyé aux abonnés.

Message d'erreur

Les e-mails concernant la notification de monétisation ne sont pas envoyés aux abonnés. Aucun message d'erreur ne sera observé.

À propos des notifications d'événements liés à la monétisation

La monétisation est compatible avec les notifications d'événements qui vous permettent de:

  1. Informer tous les développeurs d'événements tels que les nouveaux produits, les nouvelles versions des conditions d'utilisation ou les nouveaux plans tarifaires.
  2. Informer des développeurs spécifiques d'événements tels qu'un document de facturation en cours de publication ou lorsqu'un certain pourcentage de leur nombre cible de transactions est atteint (s'ils ont souscrit un forfait de notification ajustable)
  3. Informer un fournisseur d'API des événements liés aux développeurs, tels que la création d'un compte ou l'inscription d'un développeur à un plan tarifaire.
  4. Pour en savoir plus sur les types de notifications disponibles et sur la façon de les configurer, cliquez ici.

Prérequis

Assurez-vous que les conditions préalables suivantes sont remplies:

  1. Acceptation du plan tarifaire

    Pour les notifications de monétisation suivantes, vérifiez si les développeurs ont accepté le plan tarifaire correspondant :

    1. Nouveau plan tarifaire
    2. Plan tarifaire révisé
    3. Plan tarifaire expiré
    4. Plan tarifaire renouvelé
    5. Limitation du débit dépassée
    6. Plan tarifaire Freemium épuisé

      Si le développeur n'a pas accepté le plan tarifaire, ces notifications ne se déclenchent pas pour ce développeur spécifique.

  2. Exécuter le planificateur de tâches pour la notification spécifique

    La monétisation fournit un planificateur de jobs et un ensemble de jobs préprogrammés pour s'exécuter à des heures prédéfinies. Le planificateur de jobs doit être exécuté pour une notification spécifique. Si elle n'est pas exécutée, les notifications ne seront pas déclenchées.

    1. Suivez les instructions fournies dans le document suivant pour vérifier si la tâche planifiée pour une notification spécifique a été exécutée:

      Planifier des tâches de monétisation

      Remarque:Vous pouvez toujours modifier la programmation en fonction de votre cas d'utilisation.

    2. Si le job planifié pour la notification spécifique a déjà été exécuté et que vous ne recevez toujours pas de notifications, passez à la section Causes possibles pour résoudre le problème.
    3. Si ce n'est pas le cas, attendez que la tâche planifiée s'exécute pour la notification spécifique.

Causes possibles :

Voici quelques-unes des causes possibles de ce problème:

Cause Description Instructions de dépannage applicables aux
Configuration SMTP incorrecte La configuration SMTP fournie est incorrecte. Utilisateurs du cloud privé Edge

Planification des tâches de notification

La tâche de notification n'a pas démarré. Utilisateurs de cloud public et de cloud privé Edge

Cause 1: configuration SMTP incorrecte

Diagnostic

  1. Vérifiez le fichier /opt/apigee/edge-mint-management-server/conf/apix-mint.properties et assurez-vous que les propriétés SMTP suivantes sont correctement définies.
    mint.notification.javaMail.properties={"mail.smtp.host": "smtp.gmail.com",
    "mail.smtp.port": "465", "mail.smtp.starttls.enable": "true", "mail.smtp.auth": "true", "mail.smtp.username": "blah@gmail.com", "mail.smtp.password": "blah" }
    
  2. Vérifiez l'exactitude des paramètres utilisateur et du serveur SMTP. Si ces paramètres sont incorrects ou ne sont pas définis, passez à l'étape 3. Si c'est le cas, passez à l'étape 4.
  3. Mettez à jour correctement les paramètres utilisateur et de serveur SMTP en suivant les instructions du document suivant:

    /private-cloud/latest/configuring-edge-smtp-server

  4. Vérifiez à nouveau si les notifications de monétisation fonctionnent bien. Sinon, passez à l'étape 5.
  5. Si les paramètres SMTP sont corrects, exécutez l'appel d'API View notifications sent (Afficher les notifications envoyées) pour consulter l'état de la notification envoyée.
    1. Cette API renvoie un fichier JSON contenant toutes les notifications déclenchées et leur état.
    2. Vous trouverez ci-dessous un exemple de code JSON :
      {
              "hasMoreItems" : false,
              "notifications" : [ {
              "fromAlias" : "No Reply",
              "fromEmail" : "****@apigee.com",
              "id" : "4e2d0d9a-69a4-4430-957d-02fa2a3cb581",
              "notificationType" : "EMAIL",
              "orgId" : "myorg",
              "rawMessage" : "...",
              "retryCount" : 0,
              "retryStatuses" : [ {
                   "responseCode" : 0,
                   "responseMessage" : "{\"Headers\":null,\"Content : \":null,\"StatusCode\":\"0\"}",
                   "retriedAt" : 1518605291092,
                   "retryAttempt" : 0
              } ],
              "source" : "MailTo: [****@blah.com], Org: [myorg], EventType: [UPDATE_DEVELOPER]",
              "status" : "FAILED",
              "subject" : "Notification of developer changing company details",
              "templateId" : "814315c8-d8ca-4b3e-90bb-a8366600e625",
              "templateName" : "DEFAULT_UPDATE_DEVELOPER_TEMPLATE",
              "templateParametersJSON" : "{\"developer.legalName\":\"\",\"developer.name\":\"John Smith\"}",
              "toAlias" : "***@blah.com",
              "toEmail" : "***@blah.com",
              "unsubscribeURL" : "..."
      }
      

      Si vous consultez le fichier JSON, l'état affiché est "FAILED" (ÉCHEC). pour la notification Mettre à jour le développeur ci-dessus.

  6. Il est possible que le serveur SMTP et le port ne soient pas accessibles à partir du serveur de gestion. Utilisez la commande telnet pour vérifier si vous pouvez vous connecter au serveur SMTP spécifié sur le port indiqué.
    telnet <SMTP-server-IP-address> <SMTP-Port#>
    

    Si vous obtenez l'erreur "Connection timed out" (Expiration du délai de connexion) ou "Connexion refusée" pour la sortie Telnet, puis passez à la section "Résolution".

Solution

  1. Contactez votre administrateur réseau pour vérifier que le serveur SMTP est en mesure d'accepter les connexions provenant d'autres machines et que le port spécifique est ouvert sur l'extérieur pour la communication.
  2. Si le problème persiste, passez à la section "Doit collecter des informations de diagnostic" à l'aide de l'

Cause 2: planification du job de notification

La tâche de notification n'a pas démarré.

Diagnostic

  1. Exécutez l'appel d'API suivant pour afficher tous les jobs de monétisation actuellement planifiés.

    /monetize/apis/get/triggers

  2. Vérifiez si la condition de notification est présente et activée pour la notification qui ne fonctionne pas. Si ce n'est pas le cas, passez à l'étape 3 pour créer la condition de notification et ignorez les étapes restantes.
    1. S'il est présent, vérifiez s'il est activé sur "true". Si ce n'est pas le cas, exécutez l'API Update a notification condition and action API pour mettre à jour la condition de notification.

      OU

    2. Utilisez l'interface utilisateur pour mettre à jour la condition de notification en suivant la procédure décrite dans le document ci-dessous:

      Interface utilisateur des événements

    3. Exécutez l'appel d'API Create a notification condition and action API (Créer une condition de notification et une action d'action) pour créer la condition de notification appropriée et l'action correspondante.
      1. Une fois la condition de notification créée, exécutez l'appel d'API List notification conditions and actions pour vérifier qu'elle a bien été créée.
      2. Vous pouvez également traiter à nouveau la notification à l'aide de l'option Reprocess a Notification API (Retraiter une API de notification).
    4. Cette étape ne concerne que les utilisateurs de Private Cloud. Si la condition de notification obtenue à l'étape 1 est présente et que les e-mails de notification ne sont toujours pas envoyés, consultez le journal /opt/apigee/var/log/edge-management-server/logs/system.log du serveur de gestion pour voir si la condition de notification a été déclenchée.
      grep "Executing Mint Scheduler" /opt/apigee/var/log/edge-management-server/logs/system.log | grep  -o  "Executing Mint Scheduler : \[.*\]" | grep -v "for org : \[null\]" |sort | uniq -c
      
    5. Si la condition de notification est déclenchée et que vous ne recevez toujours pas de notifications, passez à la section Doit collecter des informations de diagnostic avec les informations et les résultats des étapes ci-dessus capturées.

Solution

  1. Traiter à nouveau la notification à l'aide de l'API Reprocess a Notification API

Vous devez collecter des informations de diagnostic

Si le problème persiste après avoir suivi les instructions ci-dessus, veuillez contacter l'assistance Apigee Edge. et fournissez les informations de diagnostic suivantes.

Les utilisateurs des clouds publics et privés doivent fournir les informations ci-dessous:

  1. Nom de l'organisation
  2. Nom de l'environnement
  3. Problème lié à la notification de monétisation qui n'a pas fonctionné
  4. Des informations sur les sections de ce playbook qui ont fait l'objet de tests et toute autre information susceptible de nous aider à résoudre rapidement le problème

Outre les informations ci-dessus, les utilisateurs de Private Cloud doivent également fournir les informations suivantes:

  • Journal du serveur de gestion

    /opt/apigee/var/log/edge-management-server/logs/system.log