Configuration des détails de l'expéditeur pour les notifications par courrier électronique

Modifier en ligne

Découvrez comment la recherche hiérarchique fonctionne pour les détails de l'expéditeur de notification par courrier électronique et comment vous pouvez configurer les détails de l'expéditeur au niveau de l'espace et du catalogue.

Avant de commencer

L'un des rôles suivants est requis pour configurer les détails de l'expéditeur pour les notifications par courrier électronique:

Administrateur
Propriétaire
Un rôle personnalisé avec le droit Cloud settings:Manage ou Settings:Manage

Pour plus d'informations sur les modèles de notification, leur champ d'application et la manière de les personnaliser, consultez la section « Configuration des notifications au niveau de l'organisme prestataire ».

A propos de cette tâche

API Connect envoyer automatiquement des notifications par e-mail lorsque certains événements système se produisent. Ces notifications contiennent un nom et une adresse d'expéditeur basés sur une recherche hiérarchique des détails d'expéditeur configurés dans API Connect. Selon le modèle d'e-mail envoyé, la recherche peut commencer au niveau de l'espace, au niveau du catalogue, au niveau de l'organisation de type fournisseur ou au niveau du cloud. Les détails de l'expéditeur utilisés sont le premier ensemble de détails configurés trouvés lors de la recherche hiérarchique.

Le tableau suivant montre le point de départ de la recherche hiérarchique des détails de l'expéditeur pour chaque modèle d'e-mail, en fonction de la portée du modèle, où:

Cloud : les e-mails sont envoyés à partir des informations configurées dans la section Paramètres > Notifications du Cloud Manager.
Org: la recherche des détails de l'expéditeur commence au niveau de l'organisation de type fournisseur ; si elle n'est pas disponible, les détails du cloud sont utilisés.
Catalogue: la recherche des détails de l'expéditeur commence au niveau du catalogue ; s'ils ne sont pas disponibles, les détails de l'organisation sont utilisés, et s'ils ne sont pas disponibles, les détails du cloud sont utilisés.
Espace: la recherche des détails de l'expéditeur commence au niveau de l'espace. S'ils ne sont pas disponibles, les détails du catalogue sont utilisés, s'ils ne sont pas disponibles, les détails de l'organisation sont utilisés et, s'ils ne sont pas disponibles, les détails du cloud sont utilisés.
Espace ou catalogue: dans ces cas, la recherche commence au niveau de l'espace ou au niveau du catalogue, en fonction de l'utilisateur à l'origine de la demande, comme indiqué dans la liste suivante:
- Lorsqu'un utilisateur lance une modification du cycle de vie du produit dans un Espace, la recherche des informations relatives à l'expéditeur commence au niveau de l'Espace.
- Lorsqu'un utilisateur lance une modification du cycle de vie du produit dans un catalogue, la recherche des informations relatives à l'expéditeur commence au niveau du catalogue.
- Lorsqu'un utilisateur valide le cycle de vie d'un produit dans un Espace, la recherche des coordonnées de l'expéditeur commence au niveau de l'Espace.
- Lorsqu'un utilisateur valide la modification du cycle de vie d'un produit dans un catalogue, la recherche des coordonnées de l'expéditeur commence au niveau du catalogue.

Tableau 1. Point de départ pour la recherche des coordonnées de l'expéditeur pour chaque modèle d'e-mail
Portée	Nom du modèle	Objet de l'e-mail	Détails sur l'expéditeur
administrateur	connexion-test-serveur-messagerie	Message de test de IBM® API Connect.	le cloud
administrateur	invitation-membre	Invitation à une organisation d'administration dans IBM API Connect.	le cloud
administrateur	mot-de-passe-modifié	Mot de passe modifié pour votre compte utilisateur dans IBM API Connect.	le cloud
administrateur	mot-de-passe-réinitialisé	Demande de réinitialisation de mot de passe pour votre compte utilisateur dans IBM API Connect.	le cloud
fournisseur	invitation	Invitation à créer une organisation de type fournisseur d'API dans IBM API Connect.	le cloud
fournisseur	invitation-membre	Invitation à une organisation de type fournisseur d'API dans IBM API Connect.	Organisation
catalogue	cycle-de-vie-application-annulé	Demande retirée à `{{action}}` application `{{appName}}`.	Catalogue
catalogue	demande-cycle-de-vie-application	Demande d'approbation à l'application `{{action}}` `{{appName}}`.	Catalogue
catalogue	invitation	Invitation à créer un catalogue d'API dans IBM API Connect.	Organisation
catalogue	invitation-membre	Invitation à un catalogue d'API dans IBM API Connect.	Catalogue
catalogue	demande-intégration-consommateur-tâche	Demande d'intégration d'un consommateur dans le catalogue des consommateurs de l' `{{catalog}}`.	Catalogue
catalogue	tâche-cycle-de-vie-produit-approuvée	Demande approuvée pour le produit d'API `{{action}}` dans le catalogue `{{catalog}}`.	Espace ou catalogue
catalogue	tâche-cycle-de-vie-produit-annulée	Demande retirée à `{{action}}` un produit d'API dans le catalogue `{{catalog}}` .	Espace ou catalogue
catalogue	tâche-cycle-de-vie-produit-refusée	Demande refusée au produit d'API `{{action}}` dans le catalogue `{{catalog}}`.	Espace ou catalogue
catalogue	tâche-cycle-de-vie-produit-en-attente	Demande reçue pour le produit d'API `{{action}}` dans le catalogue `{{catalog}}`.	Espace ou catalogue
catalogue	demande-tâche-cycle-de-vie-produit	Demande d'approbation à `{{action}}` un produit d'API dans le catalogue `{{catalog}}` .	Espace ou catalogue
catalogue	abonnement-tâche-annulé	Demande retirée pour s'abonner à un produit d'API dans le catalogue `{{catalog}}` .	Catalogue
catalogue	demande-abonnement-tâche	Demande d'approbation pour l'abonnement à un produit d'API dans le catalogue `{{catalog}}` .	Catalogue
espace	invitation	Invitation à créer un espace d'API dans IBM API Connect.	Catalogue
espace	invitation-membre	Invitation à un espace d'API dans IBM API Connect.	Espace
consommateur	compte-approuvé	`{{catalogTitle}}` L'inscription au compte du catalogue grand public a été approuvée.	Catalogue
consommateur	compte-refusé	`{{catalogTitle}}` L'enregistrement du compte dans le catalogue grand public a été refusé.	Catalogue
consommateur	approbation-compte-en-attente	`{{catalogTitle}}` L'inscription au compte du catalogue grand public est en attente de validation.	Catalogue
consommateur	cycle-de-vie-application-approuvé	Demande approuvée à l'application `{{action}}` `{{appName}}`.	Catalogue
consommateur	cycle-de-vie-application-refusé	Demande refusée à l'application `{{action}}` `{{appName}}`.	Catalogue
consommateur	cycle-de-vie-application-en-attente	Demande reçue à l'application `{{action}}` `{{appName}}`.	Catalogue
consommateur	application-rétablie	`{{appName}}` L'application a été réintégrée dans le catalogue grand public de l' `{{consumerOrg}}`.	Catalogue
consommateur	application-suspendue	`{{appName}}` application suspendue dans le catalogue grand public d' `{{consumerOrg}}`.	Catalogue
consommateur	invitation	Invitation à créer une organisation utilisatrice d'API dans le catalogue des utilisateurs de l' `{{catalog}}`.	Catalogue
consommateur	invitation-membre	Invitation à rejoindre le catalogue des utilisateurs de l' `{{catalog}}`.	Catalogue
consommateur	mot-de-passe-modifié	Le mot de passe de votre compte utilisateur dans le catalogue grand public d' `{{portalTitle}}` a été modifié.	Catalogue
consommateur	mot-de-passe-réinitialisé	Demande de réinitialisation du mot de passe pour votre compte du catalogue grand public `{{catalog}}`.	Catalogue
consommateur	Inscrivez-vous	`{{catalogTitle}}` Inscription à un compte sur le catalogue grand public.	Catalogue
consommateur	abonnement-tâche-approuvé	Demande d'abonnement à l'API approuvée pour l'application `{{appName}}`.	Catalogue
consommateur	abonnement-tâche-refusé	Demande d'abonnement à l'API refusée pour l'application `{{appName}}`.	Catalogue
consommateur	abonnement-tâche-en-attente	Demande d'abonnement d'API reçue pour l'application `{{appName}}`.	Catalogue

Les détails de l'adresse de l'expéditeur peuvent être configurés à quatre niveaux: cloud, organisation de type fournisseur, catalogue et espace, et vous pouvez définir une adresse d'expéditeur différente pour chaque organisation de type fournisseur, catalogue ou espace, selon les besoins. L'adresse d'expéditeur pour le Cloud peut être configurée dans l'interface utilisateur de Cloud Manager; pour plus de détails. L'adresse d'expéditeur de l'organisation prestataire peut être configurée dans l'interface utilisateur de l'API Manager; pour plus de détails, consultez la section « Configuration des notifications ». Toutefois, l'adresse de l'expéditeur pour les catalogues et les espaces ne peut être configurée qu'à l'aide de l'interface de ligne de commande du kit d'outils, comme expliqué dans les étapes suivantes.

Procédure

Connectez-vous au serveur de gestion depuis la ligne de commande en tant que membre d'un organisme prestataire. Pour plus d'informations, consultez la section « Connexion à un serveur de gestion ». Vous pouvez utiliser le même serveur de gestion URL, le même nom d'utilisateur et le même mot de passe dans la commande de connexion que vous utilisez pour vous connecter à l'interface utilisateur API Manager.
Pour mettre à jour les détails de l'adresse de l'expéditeur d'un espace, exécutez les commandes suivantes.
1. Exécutez la commande apic space-settings:get pour lire les paramètres d'espace en cours et les afficher dans un fichier json . Par exemple :
```
apic space-settings:get --server my_mgt_server --org my_provider_org --catalog my_catalog --space my_space --format json
```
  Où :
  - my_mgt_server est le point final de votre serveur de gestion ou URL.
  - my_provider_org est le nom de votre organisation de type fournisseur.
  - my_catalog est le nom de votre catalogue.
  - my_space est le nom de votre espace.
2. Créez une copie du fichier de sortie que vous pourrez ensuite utiliser pour mettre à jour les paramètres, par exemple:
```
cp space-setting.json space-setting-update.json
```
3. Editez le fichier de paramètres copié pour mettre à jour le bloc email_sender . Par exemple :
```
vi space-setting-update.json
...
  "email_sender": {
    "custom": true,
    "name": "NO REPLY: space sender name",
    "address": "space_sender_email@nomail.com"
  },
...
```
  Où :
  - custom doit être remplacé par le paramètre par défaut false par true.
  - Il faut ajouter cette name ligne au fichier et compléter les space sender name informations.
  - Il faut ajouter cette address ligne au fichier et compléter les space_sender_email@nomail.com coordonnées.
  Remarque : veuillez ignorer les autres détails de configuration contenus dans ce fichier de paramètres.
4. Exécutez la commande space-settings:update pour mettre à jour les paramètres d'espace avec les détails de la nouvelle adresse de l'expéditeur. Par exemple :
```
apic space-settings:update --server my_mgt_server --org my_provider_org --catalog my_catalog --space my_space space-setting-update.json
```
  Où space-setting-update.json est le nom de votre fichier de paramètres mis à jour.
Pour mettre à jour les détails de l'adresse de l'expéditeur d'un catalogue, exécutez les commandes suivantes.
1. Exécutez la commande apic catalog-settings:get pour lire les paramètres de catalogue en cours et les générer dans un fichier json . Exemple :
```
apic catalog-settings:get --server my_mgt_server --org my_provider_org --catalog my_catalog --format json
```
  Où :
  - my_mgt_server est le point final de votre serveur de gestion ou URL.
  - my_provider_org est le nom de votre organisation de type fournisseur.
  - my_catalog est le nom de votre catalogue.
2. Créez une copie du fichier de sortie que vous pourrez ensuite utiliser pour mettre à jour les paramètres, par exemple:
```
cp catalog-setting.json catalog-setting-update.json
```
3. Editez le fichier de paramètres copié pour mettre à jour le bloc email_sender . Par exemple :
```
vi catalog-setting-update.json
...
  "email_sender": {
    "custom": true,
    "name": "NO REPLY: catalog sender name",
    "address": "catalog_sender_email@nomail.com"
  },
...
```
  Où :
  - custom doit être remplacé par le paramètre par défaut false par true.
  - La ligne name doit être ajoutée au fichier et les détails catalog sender name doivent être renseignés.
  - La ligne address doit être ajoutée au fichier et les détails de l'adresse catalog_sender_email@nomail.com doivent être renseignés.
  Remarque : veuillez ignorer les autres détails de configuration contenus dans ce fichier de paramètres.
4. Exécutez la commande catalog-settings:update pour mettre à jour les paramètres du catalogue avec les détails de la nouvelle adresse de l'expéditeur. Par exemple :
```
apic catalog-settings:update --server my_mgt_server --org my_provider_org --catalog my_catalog catalog-setting-update.json
```
  Où catalog-setting-update.json est le nom de votre fichier de paramètres mis à jour.

Résultats

Vous comprenez maintenant comment la recherche hiérarchique fonctionne pour les détails de l'expéditeur de chaque modèle d'e-mail et vous pouvez mettre à jour les détails de l'expéditeur au niveau de l'espace et du catalogue, selon les besoins.