API do Gmail para envio de e-mail: Um guia abrangente para desenvolvedores

Registre-se no Console de desenvolvedores do Google e crie um novo projeto ou use um projeto existente do Google.

Navegue até a seção "Credenciais" no Google Developers Console.
Crie credenciais de "ID de cliente OAuth" para obter acesso às suas APIs habilitadas:
Tipo de aplicação: Aplicativo da Web
Nome: Seu nome interno
Adicionar 2 URIs de redirecionamento autorizados:
https://{{YOUR_DSN}}/api/v1/hosted/google_auth_request_callback (você pode encontrar seu DSN no canto superior direito de Painel de controle da Unipile, exemplo https://api1.unipile.com:13211/api/v1/hosted/google_auth_request_callback
https://{{YOUR_DSN less port}}/api/v1/hosted/google_auth_request_callback/port{{YOUR_DSN less domain}} (você pode encontrar seu DSN no canto superior direito do Unipile Dashboard, por exemplo https://api1.unipile.com/api/v1/hosted/google_auth_request_callback/port13211

Clique em "CREATE" (Criar)
Adicione o ID do cliente e o segredo do cliente ao Unipile Dashboard > Settings > Google OAuth

Vá para a seção "Library" (Biblioteca) no Google Developers Console.
Habilite as bibliotecas de API necessárias:
Procure e ative todas as bibliotecas de API de que seu aplicativo precisará: API do Gmail

Durante a implementação, você pode manter seu Projeto Google em diferentes estados:

"Tipo de usuário" como "Interno": Nesse modo, seu aplicativo é limitado aos usuários do Google Workspace dentro da sua organização.
'User Type' (Tipo de usuário) como 'External' (Externo) e 'Publishing Status' (Status de publicação) como 'In Testing' (Em teste):
Observação: Enquanto estiver "Em teste", você precisará adicionar usuários de teste. Os tokens expiram em 7 dias e exigem que os usuários se reautentiquem.
Para obter mais informações sobre o status de publicação, clique aqui.
Para obter detalhes sobre os tipos de usuário, clique aqui.

Certifique-se de selecionar o tipo de usuário e o status de publicação adequados com base na fase de teste e implantação do projeto.

Acesse a seção "Enabled APIS and Services" (APIS e serviços ativados) no Google Developers Console.
Verifique as APIs habilitadas: Revise e verifique a lista completa de APIs que você ativou em seu Projeto Google.
O Dashboard fornece uma visão geral de todas as APIs ativadas, permitindo que você confirme o status das APIs selecionadas para o seu projeto. Use essa seção para garantir que as APIs necessárias estejam ativadas para uma integração perfeita com o seu aplicativo.

Certifique-se de que as seguintes informações sejam fornecidas:

Digite o nome do seu aplicativo: Especifique o nome do seu aplicativo.
E-mail de suporte ao usuário: Inclua um endereço de e-mail para os usuários entrarem em contato em caso de dúvidas sobre o consentimento. Recomende o uso de um alias ou lista de distribuição com as partes relevantes incluídas.
Adicione o logotipo do seu aplicativo: Carregue o logotipo de seu aplicativo para identificação visual.

O preenchimento dessas informações na seção da tela de consentimento do OAuth é essencial para que os usuários entendam e confiem no seu aplicativo durante o processo de consentimento. Inclua detalhes precisos e elementos de marca para que a experiência do usuário seja tranquila.

Forneça as seguintes informações na seção App Domain (Domínio do aplicativo):

URL da página inicial do aplicativo: Adicione o URL da página inicial do seu aplicativo.
Certifique-se de que ela seja uma verdadeira página inicial e não apenas uma página de "login".
Link da política de privacidade do aplicativo: Inclua um link para a Política de Privacidade do seu aplicativo.
Importante: Certifique-se de que sua equipe jurídica analise a Política de Privacidade para atender Requisitos específicos do Googleparticularmente na seção "Uso limitado" do documento fornecido.
Link dos Termos de Serviço do Aplicativo: Adicione um link para os Termos de Serviço do seu aplicativo.

Siga estas etapas para adicionar domínios autorizados:

• Adicione o domínio do aplicativo utilizado em seu Google Project. Certifique-se de que seu domínio seja o de nível de produção, não o de desenvolvimento/estágio.
• Adicionar domínio unipile.com

• Digite um endereço de e-mail:
  • Forneça um endereço de e-mail para informações de contato do desenvolvedor.
  • Importante: esse deve ser um endereço de e-mail de lista de distribuição, garantindo que todas as partes relevantes recebam e-mails relacionados à Verificação do Google e notificações sobre quaisquer alterações em seu projeto. Mantenha essa lista de distribuição atualizada à medida que os membros da equipe entram e saem.
• Monitoramento pós-verificação:
  • Após o envio para verificação, monitore de perto o projeto do Google para verificar se há algum item de ação do Google.
  • Observação: O Google envia e-mails para esse endereço, mas eles podem acabar em pastas de spam ou ser bloqueados pelos servidores. Verifique regularmente se há atualizações para não perder comunicações importantes.

Certifique-se de inserir um endereço de e-mail monitorado ativamente e verificado regularmente para manter-se informado sobre o status do seu projeto do Google e quaisquer ações necessárias após a verificação.

• Clique no botão "ADD OR REMOVE SCOPE" (Adicionar ou remover escopo) para acessar o menu.
• Adicione os seguintes escopos (se eles não aparecerem na lista, atualize a página):
  ./auth/gmail.send
  ./auth/gmail.labels
  ./auth/gmail.readonly
  ./auth/gmail.modify (não é necessário se você não quiser mover ou excluir e-mails. Você terá que demonstrar ao Google que realmente o utiliza. Informe-nos para removê-lo em sua conta Unipile manualmente)

Você pode prosseguir com esta etapa somente quando sua integração estiver totalmente concluída e operacional na produção.

Produzir e hospedar um vídeo de demonstração que atenda às estipulações do Google. Para validar o seu aplicativo com o Google, você também deve enviar um vídeo demonstrando a funcionalidade do seu aplicativo. Esse vídeo deve ser carregado como um vídeo do YouTube "Não listado" para fins de verificação, e somente um link de vídeo é permitido.

• Seu aplicativo e o fluxo do OAuth são apresentados em inglês, conforme indicado na documentação do Google em "Apps requesting sensitive scopes" (Aplicativos que solicitam escopos confidenciais) e "Apps requesting restricted scopes" (Aplicativos que solicitam escopos restritos).
• A demonstração é realizada em um domínio de nível de produção.
• Nas configurações do Google Project, navegue até Navigation Menu -> APIs & Services -> OAuth Consent Screen e confirme o seguinte:
  • O status de publicação está definido como "Em produção".
  • O tipo de usuário é designado como "Externo".

• Exiba a página inicial de seu aplicativo com o URL completo, enfatizando seu status de produção.
• Ilustre como um cliente do Google pode conectar sua conta, enfatizando o uso do botão oficial de login do Google.
• Durante o fluxo de autenticação, ao apresentar a tela do processo OAuth, destaque o URL e arraste-o para revelar o ID do CLIENTE no URL.

• Mostre sequencialmente cada conjunto de escopos solicitados, adaptando-os ao seu caso de uso específico.
• Demonstre a funcionalidade bidirecional mostrando a sincronização entre seu aplicativo e o Gmail. Use guias separadas para alternar entre o seu aplicativo e cada seção relevante do Gmail. Por exemplo, enviar um e-mail por meio de seu aplicativo, ilustrando como as alterações são sincronizadas na lista de e-mails enviados no Gmail e, por outro lado, exibir o recebimento de um e-mail recebido em seu aplicativo.

Seguindo essas diretrizes, seu vídeo de demonstração transmitirá com eficiência o processo de autenticação e os recursos funcionais do seu aplicativo em sincronia com os serviços do Google.

Depois de criar seu vídeo de demonstração e garantir que ele esteja em conformidade com todos os critérios descritos, compartilhe conosco o URL do vídeo do YouTube. Podemos ajudar no processo de revisão ou você pode continuar enviando seu aplicativo para verificação diretamente.

Observe as etapas a seguir:

• Adicione o vídeo final ao seu Google Project como um link de vídeo do YouTube "não listado".
• Envie o URL do vídeo do YouTube ao seu gerente de sucesso do cliente para análise.
• Após a revisão, prossiga com o envio da verificação do aplicativo.

Lembre-se de que a duração do processo de verificação pode variar. Após o envio, pode levar de 2 a 8 semanas, dependendo da fila de envio do Google e do número de rodadas de correção consideradas necessárias. Mantenha-se informado e entre em contato conosco durante todo o processo de verificação.

Se o seu aplicativo utilizar escopos restritos, serão necessárias etapas adicionais. Aqui está uma breve visão geral do que se deve esperar:

Avaliação de segurança do Google
Para garantir a segurança dos dados do usuário, os aplicativos que solicitam acesso a dados de usuários do Google de escopo restrito devem passar por uma avaliação de segurança. Essa avaliação é fundamental para verificar se todos os aplicativos que acessam os dados de usuários do Google podem lidar com os dados de forma segura e excluir os dados de usuários quando solicitado. O processo de avaliação detalhado está descrito no site CASA (Cloud Application Security Assessment).

O Google categoriza seu aplicativo como de Nível 2 ou Nível 3

Nível 2 (autodigitalizado - verificado por laboratório) >> Mais comum
Opção de avaliação gratuita OU paga (avaliador terceirizado)
Processo CASA Tier 2
Nível 3 (escaneamento de laboratório - verificação de laboratório)
Pago - Deve ser preenchido por um avaliador terceirizado
Após receber sua classificação de Nível, o Google fornecerá instruções e ferramentas para concluir a avaliação. Consulte o link fornecido para obter informações sobre a avaliação de segurança do Google e role para baixo até as perguntas frequentes sobre a avaliação de segurança para obter informações mais detalhadas. Garanta a conformidade com esse processo para demonstrar a capacidade do seu aplicativo de lidar com os dados do usuário de forma segura ao utilizar escopos restritos.

Informações sobre a avaliação de segurança do Google

Reavaliação anual de segurança para aplicativos com escopos restritos
Os aplicativos que acessam escopos restritos devem passar por um processo de re-verificação anual de conformidade e concluir uma avaliação de segurança a cada 12 meses para manter o acesso a escopos restritos verificados. Esse processo garante a adesão contínua aos padrões de segurança e protege os dados do usuário.

Se, em algum momento, você introduzir um novo escopo restrito que não tenha sido avaliado e aprovado anteriormente, seu aplicativo poderá exigir uma reavaliação nesse momento.

A equipe de revisão do Google entrará em contato por e-mail quando for o momento de recertificar o seu aplicativo. É fundamental manter as informações do proprietário do projeto e do editor do projeto atualizadas no Cloud Console. Isso garante que os membros certos da sua equipe recebam notificações sobre essa aplicação anual, permitindo a conformidade oportuna e tranquila com os requisitos de reavaliação. Fique atento e responda prontamente às comunicações do Google para manter a segurança e a conformidade de seu aplicativo. Consulte as Perguntas frequentes do Google para obter mais informações.

Opção de lista branca
Se preferir uma alternativa aos processos padrão de verificação e análise de segurança, você tem a opção de colocar seu aplicativo na lista branca. Isso permite que você ignore os procedimentos usuais, mas é importante observar que essa opção é aplicável somente se o seu aplicativo atender a critérios muito específicos. Embora a maioria dos casos de uso não atenda a esses critérios, descrevemos os requisitos abaixo para que você avalie se a lista de permissões pode ser adequada para o seu aplicativo.

Requisitos:

A maioria dos clientes usa o Google Workspace:
A maioria de seus clientes deve usar contas do Google Workspace (antigo GSuite), ou seja, ter endereços de e-mail com o formato @company.com.
A lista branca requer ação dos administradores dos usuários finais para permitir o acesso. É necessário fornecer aos administradores dos usuários o ID do cliente do Google projet. Eles devem abrir o Console: https://admin.google.com/ac/owl/list?tab=configuredApps e permitir o client_id.
Uso limitado da conta pessoal do Gmail:
Menos de 100 contas pessoais do Gmail (endereços @gmail.com) devem poder se autenticar nesse fluxo.
Os projetos não verificados têm um limite de 100 usuários (vitalícios) por projeto. Quando incluídas na lista de permissões, as contas do Google Workspace não contam para esse limite. No entanto, as contas pessoais do Gmail sempre contarão para esse limite.
Usuários de avaliação gratuita e Whitelisting:
Os usuários de avaliação gratuita devem usar seu endereço de e-mail do Workspace e colocar o aplicativo na lista de permissões.
Lembre-se de que a lista branca é uma solução alternativa e pode não ser adequada para todos os casos de uso. Avalie esses requisitos cuidadosamente para determinar se o seu aplicativo está alinhado com os critérios de lista branca. Em caso afirmativo, tome as medidas necessárias para atender a esses requisitos e explore essa abordagem alternativa.

O uso da API do Gmail para enviar e-mails oferece automação, personalização, integração perfeita em fluxos de trabalho e escalabilidade. Isso a torna ideal para gerenciar comunicações por e-mail em grande escala de forma eficiente e reduzir erros manuais.

Para configurar a API do Gmail, é necessário criar um projeto no Google Developers Console, ativar a API do Gmail e configurar as credenciais do OAuth para autenticação. Esse processo de configuração permite que seu aplicativo interaja de forma segura com os sistemas de back-end do Gmail.

Os principais recursos incluem listar e-mails, iniciar novos e-mails, gerenciar rótulos e configurar notificações de webhook. Esses recursos simplificam o gerenciamento de e-mails, automatizam as comunicações e aprimoram os recursos de integração em ferramentas de CRM, ATS e iPaaS.

Os desenvolvedores podem encontrar desafios, como gerenciar a autenticação OAuth, lidar com cotas de API e garantir a transmissão segura de dados de e-mail. No entanto, usar trechos de código pré-escritos e seguir as práticas recomendadas pode simplificar o processo de integração.

A API do Gmail está evoluindo com as tendências de personalização e automação. A integração da IA e do aprendizado de máquina com a API do Gmail permite análises preditivas, otimização de conteúdo e gerenciamento de e-mail mais sofisticado, impulsionando o futuro da comunicação orientada por API no desenvolvimento de software.