Configurer des notifications à l'aide de modèles

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

Que sont les modèles de notification ?

La fonctionnalité de monétisation fournit un ensemble de modèles qui définissent des exemples de texte pour différents types de notifications d'événements. Vous pouvez personnaliser chacun de ces modèles pour:

  • Informez tous les développeurs d'événements tels que de nouveaux produits, de nouvelles versions des conditions d'utilisation ou de nouveaux plans tarifaires.
  • Informez les développeurs concernés d'événements tels qu'un plan tarifaire révisé.
  • Avertir un fournisseur d'API des événements liés aux développeurs, tels que l'inscription d'un développeur à un compte ou l'inscription à un plan tarifaire
  • Avertir tous les administrateurs de l'entreprise d'un événement spécifique

Vous pouvez également créer un webhook qui définit un gestionnaire de rappel HTTP, puis configurer la condition qui déclenche le webhook, comme décrit dans la section Configurer des notifications à l'aide de webhooks.

Explorer la page "Notifications"

Accédez à la page "Notifications", comme décrit ci-dessous.

Périphérie

Pour accéder à la page Notifications à l'aide de l'interface utilisateur Edge:

  1. Connectez-vous à apigee.com/edge.
  2. Sélectionnez Publish > Monétisation > Notifications (Publier > Monétisation > Notifications) dans la barre de navigation de gauche.

La page "Notifications" s'affiche.

Comme le montre la figure, la page "Notifications" vous permet de:

Classic Edge (cloud privé)

Pour accéder à la page Notifications à l'aide de l'interface utilisateur Classic Edge:

  1. Connectez-vous à http://ms-ip:9000, où ms-ip correspond à l'adresse IP ou au nom DNS du nœud du serveur de gestion.
  2. Sélectionnez Admin > Notifications dans la barre de navigation supérieure.

La page "Notifications" vous permet de:

Modification des notifications

Pour modifier une notification à l'aide de l'interface utilisateur:

  1. Accédez à la page Notifications.
  2. Cliquez sur le à côté de la notification que vous souhaitez modifier pour développer ses détails.
  3. Modifiez les champs "Objet", "Corps du texte" et "Destinataire" (le cas échéant).

    Pour en savoir plus sur les variables pouvant être spécifiées dans un modèle de notification, consultez Utiliser des variables dans les modèles de notification.

    Consultez les sections suivantes pour en savoir plus sur la modification des notifications dans chaque catégorie:

  4. Activez une notification en cochant la case correspondante.
  5. Pour modifier d'autres notifications, répétez les étapes 2 à 4.
  6. Cliquez sur Enregistrer pour enregistrer toutes les modifications.

Un message s'affiche pour confirmer que les notifications ont bien été enregistrées. L'opération d'enregistrement peut prendre quelques minutes.

Modification des notifications pour avertir tous les développeurs

Les notifications pour les types d'événements que vous sélectionnez dans la section Notifier tous les développeurs sont envoyées à tous les développeurs.

Les notifications sont programmées pour s'exécuter en fin de journée. Une fois les notifications envoyées, les cases de l'événement sont automatiquement effacées. Vous devez les sélectionner à nouveau pour programmer des notifications pour les types d'événements associés.

Le tableau suivant répertorie les notifications en fonction des types d'événements de la section "Notifier tous les développeurs". Pour en savoir plus, consultez Modifier les notifications à l'aide de l'interface utilisateur.

Type d'événement Déclencheur Remarques
Nouveau package Nouveau package d'API disponible

Ajoutez le nom de chaque nouveau package (et les produits qu'il contient) dans le corps du modèle d'e-mail lors de votre mise à jour. Vous pouvez également ajouter un lien vers le portail des développeurs ou tout autre site Web fournissant plus d'informations sur la notification.

Nouveau produit Un nouveau produit d'API est disponible

Ajoutez le nom de chaque nouveau produit dans le corps du modèle d'e-mail lors de votre actualisation. Vous pouvez également ajouter un lien vers le portail des développeurs ou tout autre site Web fournissant plus d'informations sur la notification.

Nouveaux marchés/couverture De nouveaux produits d'API sont disponibles sur des marchés géographiques spécifiques.

Dans le cadre de votre actualisation, ajoutez le nom de chaque nouveau marché et des produits pertinents dans le corps du modèle d'e-mail. Vous pouvez également ajouter un lien vers le portail des développeurs ou tout autre site Web fournissant plus d'informations sur la notification.

Modification des notifications pour avertir les développeurs concernés

Les notifications pour les types d'événements que vous sélectionnez dans la section Notifier les développeurs concernés ne sont envoyées qu'aux développeurs concernés par ces types d'événements. Par exemple, si vous sélectionnez l'événement Plan tarifaire révisé, une notification est envoyée uniquement aux développeurs qui ont accepté le plan.

Le tableau suivant répertorie les notifications en fonction des types d'événements de la section "Notifier les développeurs concernés". Pour en savoir plus, consultez Modifier les notifications à l'aide de l'interface utilisateur.

Type d'événement Déclencheur Remarques
Conditions d'utilisation non acceptées ou expirées Les nouvelles conditions d'utilisation ont été publiées et le développeur ne les a pas encore acceptées

Cette notification est envoyée 30 jours, 7 jours et un jour avant l'entrée en vigueur des nouvelles conditions d'utilisation.

Nouveau plan tarifaire Le nouveau plan tarifaire est publié

Si le plan tarifaire est:

  • standard, tous les développeurs en sont informés.
  • Plan tarifaire de la catégorie des développeurs, seuls les développeurs appartenant à cette catégorie sont avertis.
  • Plan tarifaire du développeur, seul le développeur en question est averti.
Plan tarifaire modifié Une version plus récente d'un plan tarifaire acheté est disponible

Seuls les développeurs ayant acheté la version actuelle seront avertis. Cette notification permet aux développeurs d'examiner la nouvelle version, et de résilier ou de changer de forfait s'ils ne souhaitent pas accepter les nouveaux tarifs.

Plan tarifaire expiré Le plan tarifaire a expiré et il n'y a pas de plan tarifaire de suivi

Cette notification est envoyée lorsque vous définissez initialement une date d'expiration du plan tarifaire, et des notifications supplémentaires sont envoyées 30, 7 et un jour avant la date d'expiration. Seuls les développeurs dont le plan tarifaire a expiré seront avertis.

Forfait renouvelé L'abonnement au forfait a été renouvelé.

Informez le développeur que les frais applicables seront facturés.

Limite de débit dépassée La limite du plan tarifaire a été dépassée

Informez le développeur que les frais applicables seront facturés.

Plan tarifaire Freemium épuisé Les périodes d'utilisation sans frais, mesurées en nombre de transactions ou en jours, sont épuisées

La période d'utilisation sans frais est définie par votre plan tarifaire freemium.

Document de facturation publié

Les documents de facturation (tels que les factures) du développeur sont disponibles.

Le développeur s'inscrit à un nouveau plan tarifaire Le développeur s'inscrit à un nouveau plan tarifaire.

Modification des notifications pour avertir les fournisseurs d'API

Les notifications pour les types d'événements que vous sélectionnez dans la section Notifier le fournisseur d'API sont envoyées au fournisseur d'API que vous spécifiez.

Le tableau suivant répertorie les notifications en fonction des types d'événements dans la section "Notifier le fournisseur d'API". Pour en savoir plus, consultez Modifier les notifications à l'aide de l'interface utilisateur.

Type d'événement Déclencheur
Inscription d'un nouveau développeur

Le développeur a créé un compte.

Le développeur ajoute une application

Le développeur a créé une application.

S'inscrire au nouveau plan tarifaire (développeur)

Le développeur a souscrit un plan tarifaire.

Le développeur modifie les détails financiers

Le développeur a modifié des informations financières, telles que le nom ou l'adresse de son entreprise.

Activer ou désactiver une notification

Pour activer ou désactiver une notification à l'aide de l'interface utilisateur:

  1. Accédez à la page Notifications.
  2. Activez ou désactivez une notification en cochant ou en désélectionnant la case correspondante.
  3. Cliquez sur Enregistrer pour enregistrer toutes les modifications.

L'opération d'enregistrement peut prendre quelques minutes. Un message s'affiche pour confirmer que les notifications ont bien été enregistrées.

Configurer des notifications à l'aide de modèles à l'aide de l'API

Configurez les notifications à l'aide de l'API, comme décrit dans les sections suivantes.

Gérer les modèles de notification à l'aide de l'API

Gérez les modèles de notification à l'aide de l'API, comme décrit dans les sections suivantes:

Afficher tous les modèles de notification à l'aide de l'API

Vous pouvez lister tous les modèles de notification fournis par la monétisation en envoyant une requête GET à /mint/organizations/{org_name}/notification-email-templates. Exemple :

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \
  -u email:password

Voici un exemple de modèle d'événement qui informe les développeurs de la disponibilité d'un nouveau produit d'API:

{
    "createdDate" : 1376975394984,
    "htmlImage" : "<p>Dear ${developer.legalName} , ${developer.name} <br /> Introducing _________. For more details visit us at _________________</p>",
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "name" : "DEFAULT_NEW_PRODUCT_TEMPLATE",
    "orgId" : "myorg",
    "source" : "Mail Man Test",
    "subject" : "Notification of new product",
    "updatedDate" : 1376975394984
}

Afficher un modèle de notification à l'aide de l'API

Pour afficher un modèle de notification, envoyez une requête GET à /mint/organizations/{org_name}/notification-email-templates/{template_id}, où {template_id} correspond à l'ID du modèle. Exemple :

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b" \
  -H "Accept:application/json"  \
  -u email:password

Les éléments des modèles qui commencent par $ sont des variables. Pour en savoir plus, consultez Utiliser des variables dans les modèles de notification. Supposons que les variables de la notification renvoient les valeurs suivantes:

  • ${developer.legalName}.XYZ company
  • ${developer.name}.DEV1
  • ${QUOTA_TYPE}.Transactions
  • ${PERCENT}.90%
  • ${QUOTA_UNIT}.Calls
  • ${QUOTA_LIMIT}.100
  • ${ratePlan.monetizationPackage.products.name}.X
  • ${EXPIRY_DATE}.2016-09-30

Le message de notification fourni par le modèle se présentera comme suit:

    "Dear XYZ company, DEV1
    You have exceeded Transactions of 90% calls of 100 calls for X product. Your API calls will be blocked till 2016-09-30"

Modifier un modèle de notification à l'aide de l'API

Modifiez un modèle de notification en envoyant une requête PUT à /nint/organizations/{org_name}/notification-email-templates/{template_id}. Fournissez le contenu modifié du modèle dans le corps de la requête.

Lorsque vous personnalisez le message dans un modèle de notification, vous pouvez inclure une ou plusieurs variables. Pour en savoir plus, consultez la section Utiliser des variables dans les modèles de notification.

Par exemple, la requête suivante modifie le contenu d'une notification de nouveau produit d'API:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b " \
  -H "Content-Type: application/json" \
  -d '{
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "htmlImage" : "<p>Exciting news, we have added a new product :${Product.name}. See details in <a href="${Product.url}">New Products</a> </p>",
    "name" : "NewProductNotification",
    "organization": {
    "id": "{org_name}"
    },
    "source" : "Mail Man Test ",
    "subject" : "New Product Available: ${Product.name}"
  }' \
  -u email:password

Gérer les actions et les conditions de notification à l'aide de l'API

Gérez les actions et les conditions de notification à l'aide de l'API, comme décrit dans les sections suivantes.

Créer une condition et une action de notification à l'aide de l'API

Créez une condition et une action de notification qui entraînent une notification automatique en envoyant une requête POST à /mint/organizations/{org_name}/notification-conditions.

Lorsque vous effectuez la requête, spécifiez dans son corps la condition qui déclenche la notification et les actions à entreprendre lorsque la condition est atteinte (par exemple, l'envoi d'un e-mail de notification).

Vous définissez les détails de la condition de notification en spécifiant une ou plusieurs valeurs d'attribut. Consultez la section Propriétés de configuration des conditions de notification pour obtenir la liste des attributs. Pour une notification d'événement, la condition peut être déclenchée lorsqu'un nouveau produit est publié.

Lorsque vous définissez l'élément actions, faites référence au modèle de notification applicable. Consultez la section Propriétés de configuration des actions de notification pour obtenir la liste des actions.

Par exemple, la requête suivante spécifie que lorsque l'attribut est NEW_PRODUCT et que la valeur de l'attribut PUBLISHED est true, envoyez la notification dans le modèle avec l'ID 01191bf9-5fdd-45bf-8130-3f024694e63 (il s'agit de DEFAULT_NEW_PRODUCT_TEMPLATE).

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
  -H "Content-Type:application/json"
  -d '{
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
      "attribute": "PUBLISHED",
      "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
  }' \
  -u email:password

Afficher une condition et une action de notification à l'aide de l'API

Affichez une condition et une action de notification en envoyant une requête GET à organizations/{org_name}/notification-conditions/{condition_Id}, où {condition_Id} est l'ID de la condition. L'ID est renvoyé lorsque vous créez la condition de notification. Exemple :

curl -X GET "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -H "Accept:application/json" \
  -u email:password

Voici un exemple de réponse :

    {
    "actions" : [ {
    "actionAttribute" : "DEV_ID",
    "id" : "141ba00c-d7bd-4fef-b339-9d58b83255f4",
    "templateId" : "766aba4f-0f7a-4555-b48e-d707c48b8f4c",
    "value" : "ANY"
    }, {
    "actionAttribute" : "ORG_EMAIL",
    "id" : "21486ce1-4290-4a55-b415-165af3e93c9d",
    "templateId" : "efa4ce63-7c08-4876-984b-6878ec435994",
    "value" : "DEFAULT_LIMIT_NOTIFICATION_EMAIL"
    } ],
    "notificationCondition" : [ {
    "attribute" : "Balance",
    "id" : "2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4",
    "organization" : {
    ...
    },
    "value" : "< 0"
    } ]
    }

Modifier une condition et une action de notification à l'aide de l'API

Modifiez une condition et une action de notification en envoyant une requête POST à organizations/{org_name}/notification-conditions/{condition_Id}, où {condition_Id} est l'ID de la condition. L'ID est renvoyé lorsque vous créez la condition de notification. Lorsque vous émettez la requête, spécifiez dans le corps de la requête les modifications que vous souhaitez apporter à la condition ou à l'action de notification.

Exemple :

   $ curl -H "Content-Type:application/json" -X POST -d \
    ' {
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
    "attribute": "PUBLISHED",
    "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
    }' \
    "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -u email:password

Supprimer une condition et une action de notification à l'aide de l'API

Supprimez une condition de notification en envoyant une requête DELETE à organizations/{org_name}notification-conditions/{condition_Id}. Exemple :

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4"  \
  -H "Accept:application/json"  \
  -u email:password

Propriétés de configuration des conditions de notification

Les propriétés de configuration suivantes des conditions de notification sont disponibles lorsque vous utilisez l'API.

Nom Description Par défaut Obligatoire ?
attribute

Détails de la condition de notification. Vous pouvez spécifier un ou plusieurs attributs pour affiner la condition de notification.

La valeur peut correspondre à une ou plusieurs des valeurs suivantes:

  • ADD_RATEPLAN
  • ADHOC_NOTIFY_DEVELOPERS
  • BILLING_DOCS_PUBLISHED
  • COMPANY_ACCEPTS_INVITATION
  • COMPANY_CANCELS_INVITATION
  • COMPANY_DECLINES_INVITATION
  • COMPANY_INVITES_DEVELOPER
  • CREATE_APPLICATION
  • CREATE_DEVELOPER
  • DATE
  • DEVELOPER_ACCEPTS_INVITATION
  • DEVELOPER_CANCELS_INVITATION
  • DEVELOPER_DECLINES_INVITATION
  • DEVELOPER_INVITES_COMPANY
  • EXPIRING_TNC
  • FeeExposure
  • FREEMIUM_USED_UP
  • NEW_PACKAGE
  • NEW_PRODUCT
  • PUBLISHED
  • RATEPLAN
  • RATEPLAN_ACCEPTED
  • RATEPLAN_ENDED
  • RATEPLAN_EXPIRED
  • RATEPLAN_RENEWED
  • RATEPLAN_REVISION
  • Transactions
  • UPDATE_DEVELOPER
  • UsageTarget (valide uniquement pour la configuration de webhooks)
N/A Oui
value

Valeur de l'attribut.

N/A Non
associatedCondition

Référence à une condition associée.

N/A Non

Propriétés de configuration pour les actions de notification

Les propriétés de configuration suivantes sont disponibles pour les actions de notification lorsque vous utilisez l'API.

Nom Description Par défaut Obligatoire ?
actionAttribute

Méthode utilisée pour identifier le destinataire de la notification. Cette valeur peut correspondre à une ou plusieurs des valeurs suivantes:

  • ORG_EMAIL. Le destinataire de la notification est identifié par son adresse e-mail.
  • DEV_ID. Le destinataire de la notification est identifié par l'ID de développeur (adresse e-mail).
  • COMPANY_ADMINS. Une notification est envoyée à tous les administrateurs de l'entreprise, quelle que soit la valeur définie. Notez que les administrateurs de l'entreprise sont différents des administrateurs de l'organisation.
  • WEBHOOK. Les informations sur le destinataire de la notification sont envoyées au gestionnaire de rappel du webhook. Consultez Configurer des notifications à l'aide de webhooks.
N/A Oui
value

Valeur de l'attribut action.

Si actionAttribute est défini sur ORG_EMAIL ou DEV_ID, la valeur ANY envoie la notification à tout destinataire applicable, par exemple toute adresse ORG_EMAIL ou DEV_ID.

Si actionAttribute est défini sur WEBHOOK, définissez cette valeur sur l'ID du webhook.

Si actionAttribute est défini sur COMPANY_ADMINS, cette valeur est ignorée. Une notification est envoyée à tous les administrateurs de l'entreprise.

N/A Oui
templateID

ID du modèle de notification.

Remarque:Cette option n'est pas valide si actionAttribute est défini sur WEBHOOK.

N/A Oui
postURL

Gestionnaire de rappel pour le webhook.

Remarque:Cette option est obligatoire si actionAttribute est défini sur WEBHOOK. Cette option n'est pas valide si la valeur est définie sur ORG_EMAIL, DEV_ID ou COMPANY_ADMINS.

N/A Oui

Utiliser des variables dans les modèles de notification

Lorsque vous modifiez le message dans un modèle de notification, vous pouvez inclure une ou plusieurs variables à l'aide de Spring Expression Language (SpEL) pour représenter les valeurs renvoyées dans l'objet Transaction.

Le tableau suivant récapitule les variables de modèle de notification les plus couramment utilisées.

Variable Description
${application.name}

Nom d'une application.

${application.products.name} Nom d'un produit inclus dans une application.
${BALANCE} Solde d'un quota donné.
${developer.legalName}

Nom de l'entreprise d'un développeur.

${developer.name}

Nom d'un développeur.

${EXPIRY_DATE}

Date ou heure à laquelle une limite expire ou est réinitialisée.

${LONG_PERCENT} Pourcentage d'une limite atteinte par l'utilisation actuelle, sans symbole de pourcentage. Par exemple, 50
${PERCENT}

Pourcentage de la limite atteinte en fonction de l'utilisation actuelle, avec le symbole %. Par exemple, 50%.

${products.displayName} Nom à afficher défini pour un produit.
${QUOTA_TYPE}

Type de limite (volume de transactions, limite de dépenses ou exposition des frais).

${QUOTA_UNIT}

Unité de base pour une limite: devise (pour une limite de dépense) ou appels (pour une limite de transaction).

${QUOTA_LIMIT}

Montant d'une limite.

${ratePlan.displayName} Nom à afficher défini pour un plan tarifaire.
${ratePlan.endDate} Date à laquelle un fournisseur d'API a mis fin à un plan tarifaire.
${ratePlan.monetizationPackage.displayName}

Nom d'un package d'API.

${ratePlan.monetizationPackage.name} Nom d'un package de monétisation.
${ratePlan.monetizationPackage.products.displayName}

Nom à afficher défini pour un produit API.

${ratePlan.monetizationPackage.products.name} Nom d'un produit inclus dans un package de monétisation.
${ratePlan.startDate} Date de création d'un plan tarifaire.
${USAGE} Utilisation actuelle (total des revenus ou frais ou volume)
${USER}

Nom d'un utilisateur.

Personnalisation de votre adresse e-mail de réponse

Pour la monétisation, une adresse noreply@apigee.com par défaut est configurée pour être utilisée pour les notifications par e-mail envoyées aux entreprises et aux développeurs. Contactez l'assistance Apigee pour configurer un nom et une adresse de réponse personnalisés pour votre organisation.