Configurando detalhes do emissor para notificações por e-mail

Editar online

Entenda como a procura hierárquica funciona para os detalhes do emissor de notificação por email e como é possível configurar os detalhes do emissor no nível de Espaço e Catálogo.

Antes de Iniciar

Uma das funções a seguir é necessária para configurar detalhes do emissor para notificações por e-mail:

Administrador
Proprietário
Uma função customizada com a permissão Cloud settings:Manage ou Settings:Manage

Para obter mais informações sobre os modelos de notificação, seu escopo e como personalizá-los, consulte Configuração de notificações no nível da Organização Provedora.

Sobre essa tarefa

API Connect enviar notificações por e-mail automaticamente quando ocorrerem determinados eventos do sistema. Essas notificações contêm um nome e um endereço do emissor que são baseados em uma procura hierárquica dos detalhes do emissor configurado no API Connect. Dependendo do modelo de e-mail que está sendo enviado, a procura pode ser iniciada no nível de Espaço, no nível de Catálogo, no nível de Organização do Provedor ou no nível de Nuvem. Os detalhes do emissor usados são o primeiro conjunto de detalhes configurados que são localizados durante a procura hierárquica.

A tabela a seguir mostra o ponto de início para a procura hierárquica de detalhes do emissor para cada modelo de email, ordenado pelo escopo do modelo, em que:

Nuvem: os e-mails são enviados com base nas informações configuradas na seção Configurações > Notificações do Cloud Manager.
Organização: a procura por detalhes do emissor é iniciada no nível da organização do provedor; se não estiver disponível, os detalhes da nuvem serão usados..
Catálogo: a procura por detalhes do emissor começa no nível do catálogo; se não estiver disponível, os detalhes da organização serão usados e, se não estiverem disponíveis, os detalhes da nuvem serão usados.
Espaço: a procura por detalhes do emissor começa no nível de Espaço; se não estiver disponível, os detalhes do Catálogo serão usados, se não estiverem disponíveis, os detalhes da Organização serão usados e, se não estiverem disponíveis, os detalhes da Nuvem serão usados.
Espaço ou Catálogo: nesses casos, a procura inicia no nível de Espaço ou no nível de Catálogo, dependendo do usuário que fez a solicitação, conforme mostrado na lista a seguir:
- Quando um usuário inicia a alteração do ciclo de vida do produto em um Espaço, a pesquisa pelos detalhes do remetente começa no nível do Espaço.
- Quando um usuário inicia a alteração do ciclo de vida do produto em um Catálogo, a pesquisa pelos detalhes do remetente começa no nível do Catálogo.
- Quando um usuário aprova o ciclo de vida do produto em um Espaço, a busca pelos detalhes do remetente começa no nível do Espaço.
- Quando um usuário aprova a alteração no ciclo de vida do produto em um Catálogo, a pesquisa pelos detalhes do remetente é iniciada no nível do Catálogo.

Tabela 1. Ponto de partida para a pesquisa dos dados do remetente em cada modelo de e-mail
Escopo	Nome do modelo	Assunto do E-mail	Detalhes do remetente
administrador	mail-server-test-connection	Mensagem de teste de IBM® API Connect.	NUVEM
administrador	member-invitation	Convite para uma organização do administrador no IBM API Connect	NUVEM
administrador	password-changed	Senha mudada para sua conta do usuário em IBM API Connect.	NUVEM
administrador	password-reset	Solicitação de reconfiguração de senha para a sua conta do usuário no IBM API Connect	NUVEM
provedor	convite	Convite para criar uma organização do provedor de API no IBM API Connect	NUVEM
provedor	member-invitation	Convite para uma organização do provedor de API no IBM API Connect	Org.
catálogo	app-lifecycle-cancelled	Solicitação retirada para `{{action}}` app `{{appName}}`.	Catálogo
catálogo	app-lifecycle-request	Solicitação para aprovação para `{{action}}` app `{{appName}}`.	Catálogo
catálogo	convite	Convite para criar um Catálogo de API no IBM API Connect	Org.
catálogo	member-invitation	Convite para um catálogo da API no IBM API Connect	Catálogo
catálogo	task-consumer-onboard-request	Solicitação de integração de consumidor no Catálogo de Consumidores do `{{catalog}}`.	Catálogo
catálogo	task-product-lifecycle-approved	Solicitação aprovada para o produto de API `{{action}}` no catálogo `{{catalog}}`.	Espaço ou Catálogo
catálogo	task-product-lifecycle-cancelled	Solicitação retirada para `{{action}}` um produto de API no catálogo `{{catalog}}` .	Espaço ou Catálogo
catálogo	task-product-lifecycle-denied	Solicitação negada para o produto de API `{{action}}` no catálogo `{{catalog}}`.	Espaço ou Catálogo
catálogo	task-product-lifecycle-pending	Solicitação recebida para `{{action}}` produto de API no catálogo `{{catalog}}`.	Espaço ou Catálogo
catálogo	task-product-lifecycle-request	Solicitar aprovação para `{{action}}` um produto de API no catálogo do `{{catalog}}` .	Espaço ou Catálogo
catálogo	task-subscription-cancelled	Solicitação retirada para assinar um produto de API no catálogo `{{catalog}}` .	Catálogo
catálogo	task-subscription-request	Solicitação de aprovação para assinar um produto de API no catálogo `{{catalog}}` .	Catálogo
Espaço	convite	Convite para criar um espaço de API no IBM API Connect	Catálogo
Espaço	member-invitation	Convite para um espaço de API no IBM API Connect	Espaço
consumidor	account-approved	`{{catalogTitle}}` O cadastro da conta no Catálogo do Consumidor foi aprovado.	Catálogo
consumidor	account-denied	`{{catalogTitle}}` O registro da conta no Catálogo do Consumidor foi recusado.	Catálogo
consumidor	account-pending-approval	`{{catalogTitle}}` O registro da conta no Catálogo do Consumidor está aguardando aprovação.	Catálogo
consumidor	app-lifecycle-approved	Solicitação aprovada para `{{action}}` app `{{appName}}`.	Catálogo
consumidor	app-lifecycle-denied	Solicitação negada para `{{action}}` app `{{appName}}`	Catálogo
consumidor	app-lifecycle-pending	Solicitação recebida para `{{action}}` app `{{appName}}`.	Catálogo
consumidor	app-reinstated	`{{appName}}` O aplicativo foi reintegrado ao Catálogo do Consumidor da `{{consumerOrg}}`.	Catálogo
consumidor	app-suspended	`{{appName}}` aplicativo suspenso no Catálogo de Consumidores do `{{consumerOrg}}`.	Catálogo
consumidor	convite	Convite para criar uma organização consumidora de API no Catálogo de Consumidores do `{{catalog}}`.	Catálogo
consumidor	member-invitation	Convite para uma organização consumidora de API no Catálogo de Consumidores do `{{catalog}}`.	Catálogo
consumidor	password-changed	A senha da sua conta de usuário no Catálogo do Consumidor da `{{portalTitle}}` foi alterada.	Catálogo
consumidor	password-reset	Solicitação de redefinição de senha para sua conta no Catálogo do Consumidor da `{{catalog}}`.	Catálogo
consumidor	sign-up	`{{catalogTitle}}` Registro de conta no Catálogo do Consumidor.	Catálogo
consumidor	task-subscription-approved	Solicitação de assinatura de API aprovada para o app `{{appName}}`.	Catálogo
consumidor	task-subscription-denied	Solicitação de assinatura de API negada para o app `{{appName}}`.	Catálogo
consumidor	task-subscription-pending	Solicitação de assinatura de API recebida para o app `{{appName}}`	Catálogo

Os detalhes do endereço do emissor podem ser configurados em quatro níveis: Nuvem, Organização do Provedor, Catálogo e Espaço e é possível configurar um endereço do emissor diferente para cada Organização do Provedor, Catálogo ou Espaço, conforme necessário. O endereço do remetente para a nuvem pode ser configurado na interface do usuário do Cloud Manager; para mais detalhes. O endereço de remetente da Organização Provedora pode ser configurado na interface do usuário do API Manager; consulte Configurando notificações para obter mais detalhes. Entretanto, o endereço do emissor para Catálogos e Espaços pode ser configurado apenas usando a CLI do kit de ferramentas, conforme explicado nas etapas a seguir.

Procedimento

Faça login no servidor de gerenciamento pela linha de comando como membro de uma organização provedora. Para obter mais informações, consulte “Como fazer login em um servidor de gerenciamento ”. Você pode usar o mesmo servidor de gerenciamento URL, nome de usuário e senha no comando de login que usa para fazer login na interface de usuário do API Manager.
Para atualizar os detalhes do endereço do emissor para um Espaço, execute os comandos a seguir.
1. Execute o comando apic space-settings:get para ler as configurações de Espaço atuais e emita-as para um arquivo json . Por exemplo:
```
apic space-settings:get --server my_mgt_server --org my_provider_org --catalog my_catalog --space my_space --format json
```
  Em que:
  - my_mgt_server é o ponto de extremidade do servidor de gerenciamento ou URL.
  - my_provider_org é o nome de sua Organização do Provedor
  - my_catalog é o nome de seu Catálogo
  - my_space é o nome do seu Espaço
2. Faça uma cópia do arquivo de saída que você possa usar para atualizar as configurações, por exemplo:
```
cp space-setting.json space-setting-update.json
```
3. Edite o arquivo de configurações copiado para atualizar o bloco email_sender Por exemplo:
```
vi space-setting-update.json
...
  "email_sender": {
    "custom": true,
    "name": "NO REPLY: space sender name",
    "address": "space_sender_email@nomail.com"
  },
...
```
  Em que:
  - custom deve ser alterado da configuração padrão de false para true.
  - A name linha deve ser adicionada ao arquivo, e os space sender name detalhes preenchidos.
  - A address linha deve ser adicionada ao arquivo, e os dados space_sender_email@nomail.com do endereço devem ser preenchidos.
  Observação: ignore os demais detalhes de configuração contidos neste arquivo de configurações.
4. Execute o comando space-settings:update para atualizar as configurações de Espaço com os detalhes do novo endereço do remetente Por exemplo:
```
apic space-settings:update --server my_mgt_server --org my_provider_org --catalog my_catalog --space my_space space-setting-update.json
```
  Em que space-setting-update.json é o nome de seu arquivo de configurações atualizado
Para atualizar os detalhes do endereço do emissor para um Catálogo, execute os comandos a seguir.
1. Execute o comando apic catalog-settings:get para ler as configurações atuais do Catálogo e envie-as para um arquivo json . Por exemplo,
```
apic catalog-settings:get --server my_mgt_server --org my_provider_org --catalog my_catalog --format json
```
  Em que:
  - my_mgt_server é o ponto de extremidade do servidor de gerenciamento ou URL.
  - my_provider_org é o nome de sua Organização do Provedor
  - my_catalog é o nome de seu Catálogo
2. Faça uma cópia do arquivo de saída que você possa usar para atualizar as configurações, por exemplo:
```
cp catalog-setting.json catalog-setting-update.json
```
3. Edite o arquivo de configurações copiado para atualizar o bloco email_sender Por exemplo:
```
vi catalog-setting-update.json
...
  "email_sender": {
    "custom": true,
    "name": "NO REPLY: catalog sender name",
    "address": "catalog_sender_email@nomail.com"
  },
...
```
  Em que:
  - custom deve ser alterado da configuração padrão de false para true.
  - A linha name deve ser incluída no arquivo e os detalhes catalog sender name concluídos.
  - A linha address deve ser incluída no arquivo e os detalhes do endereço catalog_sender_email@nomail.com concluídos.
  Observação: ignore os demais detalhes de configuração contidos neste arquivo de configurações.
4. Execute o comando catalog-settings:update para atualizar as configurações do Catálogo com os detalhes do novo endereço do remetente Por exemplo:
```
apic catalog-settings:update --server my_mgt_server --org my_provider_org --catalog my_catalog catalog-setting-update.json
```
  Em que catalog-setting-update.json é o nome de seu arquivo de configurações atualizado

Resultados

Agora você entende como a procura hierárquica funciona para os detalhes do emissor para cada modelo de email e pode atualizar os detalhes do emissor no nível de Espaço e Catálogo, conforme necessário.