Les notifications de monétisation ne fonctionnent pas

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

Problème constaté

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

Message d'erreur

Les e-mails concernant les notifications de monétisation ne seront pas envoyés aux personnes abonnées. Aucun message d'erreur ne s'affichera.

À propos des notifications d'événements de monétisation

La monétisation est compatible avec les notifications d'événements, qui vous permettent d'effectuer les opérations suivantes :

  1. Informer tous les développeurs d'événements tels que de nouveaux produits, de nouvelles versions des conditions d'utilisation ou de nouveaux plans tarifaires.
  2. Informer des développeurs spécifiques d'événements tels que la publication d'un document de facturation ou l'atteinte d'un pourcentage de leur nombre cible de transactions (s'ils ont acheté un plan tarifaire à taux de notification ajustable).
  3. Informer un fournisseur d'API d'événements liés aux développeurs, par exemple lorsqu'un développeur s'inscrit à un compte ou à un plan tarifaire.
  4. Pour en savoir plus sur les types de notifications 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. Fréquence maximale dépassée
    6. Plan tarifaire Freemium épuisé

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

  2. Le planificateur de tâches doit être exécuté pour la notification spécifique

    La monétisation fournit un planificateur de tâches et un ensemble de tâches prévues pour s'exécuter à des moments prédéfinis. Le planificateur de tâches doit être exécuté pour une notification spécifique. S'il n'est pas exécuté, les notifications ne seront pas déclenchées.

    1. Suivez les instructions fournies dans le document suivant pour voir 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 planification en fonction de votre cas d'utilisation.

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

Causes possibles :

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

Cause Description Instructions de dépannage applicables à
Configuration SMTP incorrecte La configuration SMTP fournie n'est pas correcte. Utilisateurs du cloud privé Edge

Planification des tâches de notification

La tâche de notification n'a pas démarré. Utilisateurs du cloud public et 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 si les paramètres du serveur SMTP et de l'utilisateur sont corrects. Si ces paramètres sont incorrects ou non définis, passez à l'étape 3. S'ils sont corrects, passez à l'étape 4.
  3. Mettez à jour correctement les paramètres du serveur SMTP et de l'utilisateur 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 désormais. Si ce n'est pas le cas, passez à l'étape 5.
  5. Si les paramètres SMTP sont corrects, exécutez l'appel d'API Afficher les notifications envoyées pour afficher l'état de la notification envoyée.
    1. Cette API renvoie un JSON avec toutes les notifications qui ont été déclenchées et l'état de chacune d'elles.
    2. Vous trouverez ci-dessous un exemple de 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 vérifiez le JSON, l'état "ÉCHEC" s'affiche pour la notification particulière ci-dessus, "Mettre à jour le développeur".

  6. Cela peut être dû au fait que le serveur et le port SMTP ne sont peut-être pas accessibles depuis le serveur de gestion. Utilisez la commande telnet pour vérifier si vous pouvez vous connecter au serveur SMTP spécifié sur le port spécifié.
    telnet <SMTP-server-IP-address> <SMTP-Port#>

    Si l'erreur "Délai de connexion expiré" ou "Connexion refusée" s'affiche dans la sortie telnet, passez à la section Solution.

Solution

  1. Collaborez avec votre administrateur réseau et assurez-vous que le serveur SMTP peut accepter les connexions d'autres machines et que le port spécifique est ouvert au monde extérieur pour la communication.
  2. Si le problème persiste, passez à la section Vous devez collecter des informations de diagnostic avec les

Cause 2 : Planification des tâches de notification

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

Diagnostic

  1. Exécutez l'appel d'API suivant pour afficher toutes les tâches de monétisation actuellement planifiées.

    /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 elle n'est pas présente, passez à l'étape 3 pour créer la condition de notification et ignorez le reste des étapes.
    1. Si elle est présente, vérifiez si elle est activée sur "true". Si ce n'est pas le cas, exécutez l'API Mettre à jour une condition et une action de notification pour mettre à jour la condition de notification.

      OU

    2. Utilisez l'interface utilisateur pour mettre à jour la condition de notification à l'aide du processus décrit dans le document ci-dessous :

      Interface utilisateur des événements

    3. Exécutez l'appel d'API Créer une condition et une action de notification 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 Lister les conditions et actions de notification pour vérifier si la condition de notification a été créée.
      2. Vous pouvez également retraiter la notification à l'aide de l'API Retraiter une notification.
    4. Cette étape ne s'applique qu'aux utilisateurs du cloud privé. Si la condition de notification est présente à l'étape 1 et que les e-mails de notification ne sont toujours pas reçus, consultez le journal du serveur de gestion /opt/apigee/var/log/edge-management-server/logs/system.log et vérifiez 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 les notifications, passez à la section Vous devez collecter des informations de diagnostic avec les informations et le résultat des étapes ci-dessus.

Solution

  1. Retraitez la notification à l'aide de l'API Retraiter une notification.

Vous devez collecter des informations de diagnostic

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

Les utilisateurs du cloud public et privé doivent fournir les informations ci-dessous :

  1. Nom de l'organisation
  2. Nom de l'environnement
  3. Condition de notification de monétisation qui n'a pas fonctionné
  4. Informations sur les sections de ce guide qui ont été essayées et toute autre information qui nous aidera à accélérer la résolution de ce problème.

En plus des informations ci-dessus, les utilisateurs du cloud privé doivent également fournir les informations suivantes :

  • Journal du serveur de gestion

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