Tempo aproximado para leitura: 10:00:00 min

Dúvida

Como configurar a API do Google para habilitar o acesso ao Gmail via OAuth2 na integração com a NDD?

O objetivo deste documento é apoiar e descerver em como devem ser realizadas as configurações dentro do ambiente Google (Gmail) para que as aplicações NDD possam ser consideradas seguras. O procedimento é necessário para que as aplicações NDD consigam realizar a leitura da caixa de entrada Gmail, assim como o disparo dos e-mails B2B quando emitidos os documentos de saída aos destinatários.

Esta é uma documentação de apoio informativo. Para demais dúvidas ou dificuldades quanto aos procedimentos necessários a serem executados dentro da base da Google, recomendamos que acione a sua equipe de infraestrutura ou um especialista que possua conhecimento sobre a plataforma.

(Para provedores diversos de e-mail, como por exemplo Locaweb, Hostgator, entre outros, ou especificamente Microsoft, utilizar as documentação abaixo, respectivamente)

Configurar ou alterar configurações de e-mail NDD

Configurando a API da Microsoft para acesso ao Outlook via OAuth2 na NDD

Ambiente

Servidores In Loco NDD - Versão 4.8.5 ou superiror.

Solução

Para configurar corretamente a API do Google e habilitar o acesso via OAuth2, siga os passos abaixo:

1. Criar um Projeto no Google Cloud Console

1. Acesse: Google Cloud Console
2. Clique em "Selecionar projeto" e, em seguida, "Novo Projeto".
3. Nomeie o projeto e clique em "Criar".

2. Ativar a API Gmail

1. No menu de navegação, acesse: "APIs e serviços" > "Biblioteca".
2. Pesquise por "Gmail API" e clique em "Ativar".

3. Configurar a Tela de Permissão OAuth

1. Acesse: "APIs e serviços" > "Tela de permissão OAuth".
2. Selecione "Usuários Internos" ou "Externos", conforme aplicável.
3. Preencha os campos obrigatórios: nome do aplicativo, e-mail de suporte, entre outros.
4. Finalize a configuração.

4. Criar Credenciais OAuth2 e Gerar o Arquivo JSON

1. Após ativar a API, acesse: "APIs e serviços" > "Credenciais".
2. Clique em "Criar credenciais" e selecione "ID do Cliente OAuth" ou "Conta de Serviço" conforme o cenário:
   • Para aplicações web ou desktop: "ID do Cliente OAuth"
   • Para integrações de backend: "Conta de Serviço"
3. Se optar pelo ID do Cliente OAuth:
   • Escolha o tipo de aplicativo: Web ou Desktop.
   • Adicione, se necessário, o URI de redirecionamento autorizado.
4. Após a criação, baixe o arquivo JSON com as credenciais (Client ID e Client Secret).

⚠️ IMPORTANTE: O arquivo JSON contém credenciais sensíveis. Mantenha-o armazenado com segurança.

5. Gerar o Tenant ID

1. Acesse: Admin Console
2. Navegue até: Conta > Configurações da Conta > Perfil da Conta
3. Copie o Customer ID (também conhecido como Tenant ID).

6. Configuração no e-Connector Settings

1. Configure primeiro o servidor:
   • Acesse: e-Connector Settings > Configurações de E-mail > Servidores de E-mail > Gmail OAuth
2. Em seguida, configure a conta de e-mail:
   • Acesse: e-Connector Settings > Contas de E-mail
   • Insira o e-mail e carregue o arquivo JSON gerado anteriormente.

7. Ajustes Finais e Considerações

✅ Para autorizações e acessos adicionais:

1. Acesse: Admin Console
2. Navegue até: Segurança > Controles de API > Gerenciar acesso de cliente
3. Registre o Client ID e defina o escopo:
   • https://mail.google.com/

8. Configurações na NDD

1. Após realizar o passo a passo acima, nas configurações de email através do e-Connector Settings da NDD, alterar o tipo de protocolo nas configurações do Servidor de email para 'Gmail'
2. Nas configurações de Conta de e-mail, selecione o Servidor de email configurado acima para que o campo JSON seja disponível
3. Insira o JSON no respectivo campo e salve as configurações
4. Valide se a conta de email configurada está selecionada na aba B2B do JOB de emissão que realizada o envio do XML e PDF via B2B, bem como no JOB de entrada, no campo email, que receptará os XMLs emitidos por terceiros a serem recebidos.

✅ Observação:
Mesmo utilizando o arquivo JSON, o Tenant ID é útil para controle de ambientes que possuem múltiplas contas de serviço.

Qualquer dúvida quanto as configurações no e-Connector Settings da NDD, acionar o suporte TOTVS.