Envoi de courrier électronique aux abonnés à l'API

En tant qu'administrateur de site, vous pouvez utiliser l'assistant " API subscribers pour envoyer des messages à tous les abonnés de tous les plans de produits qui contiennent une ou plusieurs API sur votre portail du développeur.

Avant de commencer

Vous devez disposer d'un accès administrateur au portail de développeur pour effectuer cette tâche.
Remarque : ce module synchronise les informations d'identification des applications créées par les consommateurs dans l'interface utilisateur du site Developer Portal. Il ne peut pas synchroniser les informations d'identification des applications créées par le fournisseur dans l'interface utilisateur du gestionnaire d'API.

A propos de cette tâche

Vous pouvez utiliser l'assistant de messagerie API subscribers pour envoyer des messages à tous les abonnés de tous les plans de produit qui contiennent une API spécifique dans votre communauté de portail de développeur. Pour chaque organisation de type consommateur, vous pouvez sélectionner l'envoi des messages uniquement au propriétaire ou à tous les membres. Chaque destinataire reçoit un courrier électronique individuel.

Procédure

  1. Accédez à Personnes > Abonnés aux e-mails.
  2. Sélectionnez API subscribers, puis cliquez sur Sauvegarder.
  3. Dans la zone de texte, entrez le nom de l'API dont vous souhaitez envoyer un courrier électronique aux abonnés. Si vous commencez à saisir du texte dans cette zone, vous pouvez choisir parmi les options qui vous sont proposées. Cliquez sur Suivant.
    Remarque : vous pouvez sélectionner plusieurs API dans une liste séparée par des virgules.
  4. Sélectionnez le rôle des destinataires auxquels vous souhaitez envoyer l'e-mail, puis cliquez sur Suivant.
    • Propriétaires - envoie le courrier électronique aux propriétaires des organisations de type consommateur concernées.
    • Membres - envoie le courrier électronique à tous les membres des organisations de type consommateur concernées.
  5. Entrez le contenu du courrier électronique, l'objet et le corps du message, puis définissez le format de texte à utiliser :
    • HTML de base
    • Texte en clair
  6. Développez la liste déroulante REMPLACEMENTS et cliquez sur Parcourir les jetons disponibles pour afficher les jetons pouvant être ajoutés aux zones de sujet et de corps pour le remplacement.

    Vous pouvez sélectionner un jeton à utiliser en le saisissant directement ou en cliquant sur la zone correspondant à l'objet ou au corps. Vous obtenez ainsi une liste de jetons disponibles et vous pouvez insérer le jeton de votre choix. Pour une liste de référence des jetons, voir Référence des jetons.

  7. Développez la liste déroulante Options d'e-mail supplémentaires pour configurer des paramètres supplémentaires:
    • Priority: définissez la priorité de l'e-mail. De nombreux programmes de messagerie ignorent le paramètre de priorité.
    • Request receipt: demandez un reçu de lecture dans vos e-mails. De nombreux programmes de messagerie ignorent ces demandes donc il ne s'agit pas d'une indication définitive du nombre de personnes qui ont lu votre courrier électronique.
    • Additional headers: définissez les en-têtes supplémentaires à envoyer avec l'e-mail.
  8. Utilisez les autres cases à cocher pour configurer les messages à envoyer et leur mode de diffusion :
    • Send the message directly by using the Batch API: Cette option permet d'envoyer les courriels directement par l'API Batch. Si elle n'est pas sélectionnée, les courriers électroniques sont ajoutés au spoule et envoyés par cron.
    • Only send one email per user: Sélectionnez cette option pour que chaque utilisateur ne reçoive l'e-mail qu'une seule fois, même s'il fait partie de plusieurs API sélectionnées.
    • Send a copy of all messages to the sender: Comme les courriels peuvent contenir des jetons spécifiques au contexte, un nouveau courriel est généré pour chaque destinataire avec le remplacement correct du jeton. Cette option envoie une copie de tous les courriers électroniques générés à l'expéditeur.
    • Send a copy of the original message to the sender: Cette option envoie une copie unique de l'e-mail original, de l'objet et du corps du message, sans remplacer les éléments spécifiés.
  9. Cliquez sur Suivant.
  10. Confirmez que l'e-mail est prêt à être envoyé, puis cliquez sur Suivant. Si vous choisissez d'envoyer les courriers électroniques avec l'API de traitement par lots, vous voyez une page de progression indiquant le nombre de courriers envoyés. Vous êtes alors redirigé vers une page récapitulative qui indique le nombre total d'e-mails envoyés. Si vous avez choisi de spouler la livraison des courriels, vous êtes redirigé vers la page Résumé qui indique le nombre total de courriels spoulés.
  11. Dans la page Résumé, saisissez un nom dans la zone de texte pour enregistrer la liste d'adresses électroniques.
    Remarque : pour supprimer la liste d'adresses électroniques enregistrée,
    1. Allez dans Configuration > Système > Paramètres des abonnés e-mail et cliquez sur Supprimer en regard du nom de la liste de diffusion.
    2. Cliquez à nouveau sur Supprimer pour confirmer l'action.
    3. Cliquez sur Sauvegarder la configuration.
  12. Cliquez sur Terminer.

Résultats

Vous avez envoyé un courrier électronique à tous les membres ou à tous les propriétaires de chaque organisation de type consommateur qui contenait un abonnement à tous les plans de produit contenant l'API choisie sur votre portail de développeur.