Enfatizando a função essencial da autenticação do usuário em aplicativos modernos, ele apresenta o Google OAuth 2.0 como uma solução segura e confiável para integrar o e-mail ao seu aplicativo.
Entendendo o Google OAuth 2.0
O Google OAuth 2.0 é um protocolo de autenticação avançado que aborda as limitações da autenticação tradicional por nome de usuário e senha. Ele permite que os aplicativos acessem os dados do usuário armazenados nos servidores do Google de forma segura, sem exigir que os usuários compartilhem suas senhas.
Os tokens de acesso e de atualização são os principais componentes do Google OAuth 2.0. Os tokens de acesso fornecem autorização temporária para que os aplicativos acessem recursos específicos do usuário, enquanto os tokens de atualização permitem a renovação dos tokens de acesso sem a necessidade de os usuários inserirem novamente suas credenciais. Entender esses tokens é fundamental para a criação de sistemas de autenticação seguros nos aplicativos.
Autenticação de contas do Google para integração de e-mail em seu software
Aprenda o processo de autenticação de contas do Google para integrar perfeitamente a funcionalidade de e-mail ao seu aplicativo
Configuração das credenciais OAuth
- Acesso ao console de API do Google: Etapas para navegar e configurar seu projeto no Console de API do Google.
- Ativação de APIs: Orientação sobre como habilitar o API do Gmailpara integrar a funcionalidade de e-mail em seu projeto.
- Criação de credenciais de autorização: Instruções detalhadas para criar as credenciais de autorização necessárias.
Entendendo os tokens de acesso
Tokens de acesso servem como identificadores exclusivos que concedem acesso aos dados e às funcionalidades do usuário em várias APIs do Google. Esses tokens são versáteis, capazes de fornecer graus variados de acesso a várias APIs. O escopo dos tokens de acesso é determinado pelas permissões concedidas a eles, garantindo acesso restrito a recursos e operações específicos com base nos escopos autorizados.
Gerenciamento de escopos
Escopos ditam a extensão dos dados e das funcionalidades acessíveis pelo token de acesso de um usuário. Ao fazer login com sua conta do Google, os usuários são solicitados a consentir com os escopos solicitados pelo seu aplicativo. Se as permissões forem concedidas, o servidor de autorização do Google emitirá um token de acesso para o seu aplicativo, especificando os escopos que ele abrange. Esse processo de consentimento permite que os usuários controlem o nível de acesso concedido aos seus dados, garantindo privacidade e segurança.
Solicitações de API e gerenciamento de tokens de atualização
Ao adquirir um token de acesso, seu aplicativo ganha a capacidade de enviar solicitações HTTP para APIs relevantes do Google, normalmente transmitidas no cabeçalho da solicitação HTTP como um token de portador, conforme recomendado pelo Google. No entanto, os tokens de acesso têm uma vida útil finita, o que leva à necessidade de tokens de atualização para estender o acesso além da expiração do token inicial. Os tokens de atualização devem ser armazenados com segurança para uso prolongado e podem ser utilizados para obter novos tokens de acesso quando necessário. Na seção seguinte, vamos nos aprofundar nos diversos fluxos de autenticação OAuth suportados pelas APIs do Google.
Integração Unipile com o Google sem esforço
O Unipile simplifica o processo de integração com o Gmail. Com o Unipile, você pode estabelecer rapidamente uma integração abrangente de e-mail, reduzindo significativamente o tempo de desenvolvimento em comparação com as integrações diretas com as APIs do Google.
Principais vantagens de escolher o Hosted Auth da Unipile para integração de e-mail
O Hosted Auth da Unipile oferece uma experiência de integração de e-mail sem atritos, segura e adaptável, aumentando a eficiência do desenvolvedor e do usuário.
One Link Hosted Auth vs. Fluxo OAuth completo
O Hosted Auth com a Unipile otimiza a integração de e-mail automatizando a detecção e a autenticação do provedor, o que reduz significativamente a complexidade do desenvolvimento e economiza tempo. Essa abordagem moderna não apenas simplifica a configuração inicial, mas também garante a confiabilidade e a segurança contínuas da conexão, liberando os desenvolvedores para se concentrarem na criação de uma experiência melhor para o usuário, em vez de gerenciar as complexidades do back-end.
import { UnipileClient } from "unipile-node-sdk"; const client = new UnipileClient('https://{YOUR_DSN}', '{YOUR_ACCESS_TOKEN}'); await client.account.connectGmail({'*****'}); const messages = await client.messaging.getAllMessages();
Segurança
Aumente a proteção de dados, pois o Hosted Auth da Unipile gerencia credenciais confidenciais, reduzindo a carga de segurança em seu sistema.
Integração
Aproveite a integração perfeita com vários provedores de e-mail por meio da compatibilidade universal do Unipile, independentemente do domínio ou serviço.
Manutenção
Reduza os esforços de manutenção contínua, pois o Hosted Auth da Unipile se adapta automaticamente às mudanças ou atualizações do provedor.
Eficiência
Acelere o desenvolvimento com o Hosted Auth de um clique da Unipile, ignorando a configuração complexa dos fluxos OAuth tradicionais.
Usabilidade
Ofereça uma experiência de autenticação fácil de usar com um único link, evitando várias etapas de redirecionamento para os usuários.
Otimize seu conjunto de recursos de e-mail com a integração do Google OAuth
Explore o conjunto de recursos de primeira linha da Unipile
Configuração do Google OAuth para a Unipile
1. Visão geral do novo processo de verificação do OAuth do Google'
O Google tem um processo de verificação do OAuth, que exige que aplicativos de terceiros enviem uma solicitação ao Google para verificar o uso de dados de usuários do Google. Você precisa se submeter ao processo de verificação de aplicativos do Google, à lista de permissões de aplicativos e/ou a uma avaliação de segurança.
Embora não sejamos especialistas em criar e configurar o Google Projects, nosso objetivo é ajudá-lo com base em nossa experiência no suporte a outros clientes da Unipile durante o processo de verificação
Sinta-se à vontade para pedir orientação enquanto navega pelo terreno em constante mudança dos requisitos do Google e garante uma integração perfeita das APIs do Google em seu aplicativo por meio do Unipile.
Para iniciar o desenvolvimento, você deve concluir a fase inicial, que envolve "Criar uma conta e um projeto no Google Developers Console". Quando o desenvolvimento estiver concluído, você poderá passar para a segunda fase: "Generate your Demonstration Video" (Gerar seu vídeo de demonstração). Depois disso, você pode passar para "Whitelisting & Security Review for Restricted Scopes" (Lista de permissões e revisão de segurança para escopos restritos).
2. Crie uma conta e um projeto no Console do Google Developers
Registre-se no Console de desenvolvedores do Google e crie um novo projeto ou use um projeto existente do Google.
3. Menu de navegação - APIs & Services - 'Credentials'
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
4. Menu de navegação - APIs e serviços - Biblioteca
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
6. Menu de navegação - APIs e serviços - Tela de consentimento do OAuth
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.
5. Menu de navegação - APIs e serviços - APIS e serviços ativados
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.
7. Seção da tela de consentimento do OAuth - Informações do 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.
8. Seção da tela de consentimento do OAuth - Domínio do aplicativo
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.
9. Seção da tela de consentimento do OAuth - Domínios autorizados
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
10. Seção da tela de consentimento do OAuth - Informações de contato do desenvolvedor
- 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.
11. Seção de escopos
- 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) -
12. Gerar seu vídeo de demonstração
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.
Antes de criar o vídeo
- 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.
13. Whitelisting & Security Review for Restricted Scopes (Lista branca e revisão de segurança para escopos restritos)
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.
Recursos de e-mail
Conexão de conta
Hosted Auth: autenticação de e-mail de marca branca
Autenticação personalizada: Conectar usuário com credenciais
Gmail ou Microsoft OAuth: use a tela do seu aplicativo Oauth
Enviar/Receber
Enviar um e-mail
Responder a um e-mail
Lista de e-mails
Organize
Excluir e-mail
Mover e-mail
Listar pastas
Obter pasta
Webhooks
Novo e-mail
Rastreamento de aberturas e cliques
Explore mais com o Microsoft OAuth no Unipile
Microsoft OAuth
Para integrar as contas da Microsoft com a Unipile por meio do OAuth, a etapa inicial é configurar seu aplicativo no Azure Active Directory (AAD). Depois disso, você precisará ajustar as configurações no Unipile para reconhecer seu ID de aplicativo do AAD. Se tiver algum problema durante o processo de registro no Azure AD, entre em contato conosco para obter orientação e suporte!
FAQs
O que é o Google OAuth 2.0 e por que ele é importante para a integração de e-mail?
O Google OAuth 2.0 é um protocolo de autenticação moderno que permite que os aplicativos acessem os dados do usuário nos servidores do Google com segurança, sem precisar da senha do usuário. É crucial para a integração de e-mail porque garante a autenticação segura e confiável do usuário, aumentando a segurança do aplicativo e a confiança do usuário.
Como a Unipile usa o Google OAuth 2.0 para uma integração perfeita de e-mail?
A Unipile utiliza o Google OAuth 2.0 para autenticar usuários e obter as permissões necessárias para acessar seus dados de e-mail. Esse processo inclui a detecção automática de provedores e o gerenciamento simplificado de credenciais OAuth, reduzindo significativamente a complexidade da integração e o tempo de desenvolvimento.
Quais são os benefícios de usar o Hosted Auth da Unipile para integrar serviços de e-mail?
O Hosted Auth da Unipile oferece um processo de integração sem atritos, garantindo segurança e adaptabilidade e, ao mesmo tempo, aumentando a eficiência do desenvolvedor e do usuário. Ele simplifica o processo de autenticação, gerencia credenciais confidenciais e oferece suporte à integração perfeita entre vários provedores de e-mail.
Como funcionam os tokens de acesso e os tokens de atualização no Google OAuth 2.0?
No Google OAuth 2.0, os tokens de acesso concedem autorização temporária para acessar recursos específicos do usuário, enquanto os tokens de atualização permitem a renovação desses tokens de acesso sem exigir que o usuário se autentique novamente. Esse mecanismo garante o acesso contínuo aos dados do usuário com o mínimo de interrupção.
O Unipile pode lidar com atualizações em tempo real em meu aplicativo?
Sim, o Unipile pode integrar notificações de webhook para fornecer atualizações em tempo real ao seu aplicativo. Esses webhooks alertam o aplicativo automaticamente quando ocorrem eventos específicos, como o recebimento de novos e-mails, mantendo assim o aplicativo em sincronia com a atividade de e-mail do usuário e garantindo uma integração escalável e responsiva.
Você também pode gostar
API de sincronização de calendário para SaaS: Integração em tempo real com o Google e o Outlook
Para CRM, ATS, plataformas de alcance e software orientado por IA, uma API de calendário confiável não é mais uma coisa boa de se ter. Ela agora é um componente essencial que impulsiona a produtividade, os fluxos de trabalho de reserva, os acompanhamentos, as sequências automatizadas e a coordenação da equipe. No entanto, implementar a sincronização do calendário é uma...
O guia completo do desenvolvedor para integração da API do calendário
O software moderno é executado com base em conexões entre pessoas, sistemas e o próprio tempo. No centro dessa conectividade está a API do Calendário, um componente vital que permite que os aplicativos leiam, criem e sincronizem eventos de calendário sem problemas. Se você estiver criando um CRM, uma plataforma de recrutamento ou um...
Guia completo do desenvolvedor para integração da API de e-mail
Entendendo os dois tipos diferentes de APIs de e-mailAntes de mergulhar na integração, é importante esclarecer que o termo API de e-mail abrange dois mercados distintos com intenções muito diferentes: APIs de e-mail transacional e de marketing (por exemplo, Brevo, SendGrid, Mailgun) Essas APIs de e-mail são projetadas...
BR 
EN 
FR 
ES 
DE 
IT 
NL 
PL 
TR