Integración sencilla de la API de Gmail: guía completa.

Inscríbete en Consola de desarrolladores de Google y cree un nuevo proyecto o utilice un proyecto Google existente.

Accede a la sección "Credenciales" de Google Developers Console.
Cree credenciales 'OAuth Client ID' para acceder a sus APIs habilitadas:
Tipo de aplicación: Aplicación web
Nombre: Su nombre interno
Añadir 2 URI de redirección autorizadas:
https://{{YOUR_DSN}}/api/v1/hosted/google_auth_request_callback (puede encontrar su DSN en la parte superior derecha de Cuadro de mandos de UnipileEjemplo https://api1.unipile.com:13211/api/v1/hosted/google_auth_request_callback
https://{{TU_DSN menos puerto}}/api/v1/hosted/google_auth_request_callback/port{{TU_DSN menos dominio}} (puede encontrar su DSN en la parte superior derecha del panel de control de Unipile, por ejemplo https://api1.unipile.com/api/v1/hosted/google_auth_request_callback/port13211

Haga clic en "CREAR".
Añadir ID de cliente y secreto de cliente a Unipile Dashboard > Settings > Google OAuth

Accede a la sección "Biblioteca" de Google Developers Console.
Activar Bibliotecas API requeridas:
Busque y active todas las Bibliotecas API que necesitará su aplicación: API de Gmail

A lo largo de la implementación, puedes mantener tu Proyecto Google en diferentes estados:

Tipo de usuario" como "Interno": En este modo, tu aplicación se limita a los usuarios de Google Workspace dentro de tu organización.
Tipo de usuario" como "Externo" y "Estado de publicación" como "En pruebas":
Nota: Mientras esté "en pruebas", deberá añadir usuarios de prueba. Los tokens caducan en 7 días y requieren que los usuarios vuelvan a autenticarse.
Para más información sobre el Estado de la publicación, pulse aquí.
Para más detalles sobre los tipos de usuario, pulse aquí.

Asegúrese de seleccionar el tipo de usuario y el estado de publicación adecuados en función de la fase de prueba y despliegue de su proyecto.

Accede a la sección "APIS y servicios habilitados" de la consola de desarrolladores de Google.
Compruebe las API activadas: Revisa y verifica la lista completa de API que has habilitado en tu proyecto de Google.
El panel de control ofrece una visión general de todas las API habilitadas, lo que le permite confirmar el estado de las API seleccionadas para su proyecto. Utilice esta sección para asegurarse de que las API necesarias están habilitadas para una integración perfecta con su aplicación.

Asegúrese de que se facilita la siguiente información:

Introduzca el nombre de su aplicación: Especifique el nombre de su aplicación.
Correo electrónico de asistencia al usuario: Incluya una dirección de correo electrónico a la que los usuarios puedan dirigirse si tienen preguntas sobre su consentimiento. Se recomienda utilizar un alias o una lista de distribución que incluya a las partes interesadas.
Añada el logotipo de su aplicación: Sube el logotipo de tu aplicación para identificarla visualmente.

Completar esta información en la sección de la pantalla de consentimiento de OAuth es esencial para que los usuarios entiendan y confíen en tu aplicación durante el proceso de consentimiento. Incluye detalles precisos y elementos de marca para que la experiencia del usuario sea fluida.

Proporcione la siguiente información en la sección Dominio de la aplicación:

URL de la página de inicio de la aplicación: Añade la URL de la página de inicio de tu aplicación.
Asegúrese de que se trata de una verdadera página de inicio y no sólo de una página de "inicio de sesión".
Enlace a la política de privacidad de la aplicación: Incluya un enlace a la Política de privacidad de su aplicación.
Importante: Asegúrese de que su equipo jurídico revisa la Política de Privacidad para cumplir Requisitos específicos de Googleen particular de la sección "Uso limitado" del documento facilitado.
Enlace a las condiciones de servicio de la aplicación: Añade un enlace a las Condiciones de servicio de tu aplicación.

Siga estos pasos para añadir dominios autorizados:

• Añade el dominio de tu aplicación utilizado en tu proyecto de Google. Asegúrate de que tu dominio es el de producción, no el de desarrollo/establecimiento.
• Añadir dominio unipile.es

• Introduzca una dirección de correo electrónico:
  • Proporcione una dirección de correo electrónico para la información de contacto del promotor.
  • Importante: esta debe ser una dirección de correo electrónico de la lista de distribución, para garantizar que todas las partes relevantes reciban correos electrónicos relacionados con la verificación de Google y notificaciones sobre cualquier cambio en el proyecto. Mantén esta lista de distribución actualizada a medida que los miembros del equipo entren y salgan.
• Control posterior a la verificación:
  • Después de la presentación para la verificación, supervise de cerca el proyecto de Google para cualquier elemento de acción de Google.
  • Nota: Google envía correos electrónicos a esta dirección, pero pueden acabar en carpetas de spam o ser bloqueados por los servidores. Comprueba regularmente si hay actualizaciones para evitar perderte comunicaciones importantes.

Asegúrese de introducir una dirección de correo electrónico de seguimiento activo y comprobada con regularidad para mantenerse informado sobre el estado de su proyecto de Google y cualquier acción necesaria posterior a la verificación.

• Haga clic en el botón "AÑADIR O ELIMINAR ÁMBITO" para acceder al menú.
• Añada los siguientes ámbitos (si no aparecen en la lista, actualice la página) :
  ./auth/gmail.send
  ./auth/gmail.etiquetas
  ./auth/gmail.readonly
  ./auth/gmail.modify (no es necesario si no desea mover o eliminar el correo electrónico. Tendrás que demostrar a Google que realmente lo usas. Infórmenos para eliminarlo en su cuenta Unipile manualmente)

Sólo podrá proceder con este paso una vez que su integración esté totalmente terminada y operativa en producción.

Produce y presenta un vídeo de demostración que cumpla las estipulaciones de Google. Para validar su aplicación con Google, también debe enviar un vídeo que muestre la funcionalidad de su aplicación. Este vídeo debe subirse como un vídeo de YouTube "no incluido en la lista" con fines de verificación, y solo se permite un enlace de vídeo.

• Tu app y el flujo de OAuth se presentan en inglés, como se indica en la documentación de Google en "Apps requesting sensitive scopes" y "Apps requesting restricted scopes".
• La demostración se lleva a cabo en un dominio a nivel de producción.
• En la configuración de tu proyecto de Google, ve a Menú de navegación -> API y servicios -> Pantalla de consentimiento de OAuth y confirma lo siguiente:
  • El estado de publicación es "En producción".
  • El tipo de usuario se designa como "Externo".

• Muestre la página de inicio de su aplicación con la URL completa, destacando su estado de producción.
• Ilustrar cómo un cliente de Google puede conectar su cuenta haciendo hincapié en el uso del botón oficial de inicio de sesión de Google.
• Durante el flujo de autenticación, al presentar la pantalla del proceso OAuth, resalte la URL y arrástrela para revelar el CLIENT ID en la URL.

• Muestre secuencialmente cada conjunto de ámbitos solicitados, adaptándolos a su caso de uso específico.
• Demuestra la funcionalidad bidireccional mostrando la sincronización entre tu aplicación y Gmail. Utiliza pestañas separadas para alternar entre tu aplicación y cada sección relevante de Gmail. Por ejemplo, enviando un correo electrónico a través de tu aplicación, ilustrando cómo se sincronizan los cambios en la lista de correo enviado en Gmail y, por otro lado, mostrando la recepción de un correo electrónico entrante dentro de tu aplicación.

Si sigues estas directrices, tu vídeo de demostración transmitirá de forma eficaz el proceso de autenticación y las capacidades funcionales de tu aplicación en sincronización con los servicios de Google.

Después de crear tu vídeo de demostración y asegurarte de que cumple todos los criterios descritos, comparte la URL del vídeo de YouTube con nosotros. Podemos ayudarle en el proceso de revisión o puede enviar su aplicación directamente para su verificación.

Tenga en cuenta los siguientes pasos:

• Añade el vídeo final a tu proyecto de Google como enlace de vídeo de YouTube "no incluido en la lista".
• Envía la URL del vídeo de YouTube a tu Customer Success Manager para que lo revise.
• Tras la revisión, proceda al envío de la verificación de la aplicación.

Tenga en cuenta que la duración del proceso de verificación puede variar. Tras el envío, puede tardar entre 2 y 8 semanas, en función de la cola de envío de Google y del número de rondas de corrección que considere necesarias. Mantente informado y coordínate con nosotros durante todo el proceso de verificación.

Si su aplicación utiliza ámbitos restringidos, se requieren pasos adicionales. He aquí un breve resumen de lo que hay que prever:

Evaluación de seguridad de Google
Para garantizar la seguridad de los datos de usuario, las aplicaciones que soliciten acceso a datos de usuario de Google de alcance restringido deben someterse a una evaluación de seguridad. Esta evaluación es crucial para verificar que todas las aplicaciones que acceden a los datos de usuario de Google pueden manejar los datos de forma segura y eliminar los datos de usuario a petición. El proceso de evaluación detallado se describe en el sitio de CASA (Cloud Application Security Assessment).

Google clasifica tu aplicación como Tier 2 o Tier 3

Nivel 2 (Autoexploración - Verificación de laboratorio) >> Más común
Opción gratuita o de pago (asesor externo)
Proceso CASA de nivel 2
Nivel 3 (Escaneado en laboratorio - Verificado en laboratorio)
De pago - Debe realizarlo un evaluador externo
Tras recibir su clasificación de nivel, Google le proporcionará instrucciones y herramientas para completar la evaluación. Consulte el enlace proporcionado para obtener información sobre la evaluación de seguridad de Google y desplácese hacia abajo hasta las preguntas frecuentes sobre la evaluación de seguridad para obtener información más detallada. Garantiza el cumplimiento de este proceso para demostrar la capacidad de tu aplicación para gestionar los datos de los usuarios de forma segura al utilizar ámbitos restringidos.

Información sobre la evaluación de seguridad de Google

Reevaluación anual de la seguridad de las aplicaciones de ámbito restringido
Las aplicaciones que acceden a ámbitos restringidos deben someterse a un proceso anual de verificación de conformidad y completar una evaluación de seguridad cada 12 meses para mantener el acceso a los ámbitos restringidos verificados. Este proceso garantiza el cumplimiento continuo de las normas de seguridad y protege los datos de los usuarios.

Si, en algún momento, introduce un nuevo ámbito restringido que no ha sido evaluado y aprobado previamente, su aplicación puede requerir una nueva evaluación en ese momento.

El equipo de revisión de Google se pondrá en contacto con usted por correo electrónico cuando llegue el momento de volver a certificar su aplicación. Es fundamental que mantengas actualizada la información sobre el propietario y el editor del proyecto en tu Cloud Console. Esto garantiza que los miembros adecuados de tu equipo reciban notificaciones sobre esta aplicación anual, lo que permite cumplir a tiempo y sin problemas con los requisitos de reevaluación. Mantente alerta y responde con prontitud a las comunicaciones de Google para mantener la seguridad y el cumplimiento de tu aplicación. Consulta las preguntas frecuentes de Google para obtener más información.

Opción de lista blanca
Si prefiere una alternativa a los procesos estándar de verificación y revisión de seguridad, tiene la opción de incluir su solicitud en una lista blanca. Esto le permite eludir los procedimientos habituales, pero es importante tener en cuenta que esta opción sólo es aplicable si su aplicación cumple criterios muy específicos. Aunque la mayoría de los casos de uso no cumplen estos criterios, hemos esbozado los requisitos a continuación para que pueda evaluar si la inclusión en la lista blanca podría ser adecuada para su aplicación.

Requisitos:

La mayoría de los clientes utilizan Google Workspace:
La mayoría de tus clientes deberían utilizar cuentas de Google Workspace (anteriormente GSuite), es decir, tener direcciones de correo electrónico con el formato @empresa.es.
Las listas blancas requieren la intervención de los administradores de los usuarios finales para permitir el acceso. Tienes que proporcionar a los administradores de tus usuarios tu ID de cliente de Google projet. Ellos tienen que abrir su Consola: https://admin.google.com/ac/owl/list?tab=configuredApps y permitirte client_id.
Uso limitado de la cuenta personal de Gmail:
Menos de 100 cuentas personales de Gmail (direcciones @gmail.com) deberían poder autenticarse en este flujo.
Los proyectos no verificados tienen un límite de 100 usuarios (de por vida) por proyecto. Cuando están en la lista blanca, las cuentas de Google Workspace no cuentan para este límite. Sin embargo, las cuentas personales de Gmail siempre contarán para este límite.
Usuarios de prueba gratuitos y listas blancas:
Los usuarios de la versión de prueba gratuita deben utilizar su dirección de correo electrónico de Workspace y poner la aplicación en la lista blanca.
Tenga en cuenta que las listas blancas son una solución provisional y pueden no ser adecuadas para todos los casos de uso. Evalúe detenidamente estos requisitos para determinar si su aplicación se ajusta a los criterios de las listas blancas. Si es así, tome las medidas necesarias para cumplir estos requisitos y explore este enfoque alternativo.

La API de Gmail está diseñada para interactuar específicamente con cuentas de Gmail y no se integra directamente con otros clientes o servicios de correo electrónico. Sin embargo, los desarrolladores pueden utilizar la API para sincronizar o migrar correos electrónicos hacia o desde Gmail, y luego gestionar las interacciones con clientes que no sean de Gmail a través de sus respectivas API o protocolos como IMAP o SMTP.

La API de Gmail se adhiere a las estrictas políticas de privacidad de Google y al cumplimiento de normativas como el GDPR. El consentimiento del usuario es obligatorio, y las aplicaciones deben utilizar OAuth 2.0 para la autenticación y la autorización, garantizando que los usuarios conceden explícitamente permiso para acceder a sus cuentas de Gmail. El alcance del acceso de la aplicación se limita a lo necesario para la funcionalidad, y los usuarios pueden revocar el acceso en cualquier momento.

El coste del uso de la API de Gmail depende del número de cuentas de usuario conectadas a través de tu aplicación. Para obtener información específica sobre precios, visita la página página de precios en el sitio web de Unipile. Esto le proporcionará detalles sobre los diferentes niveles de precios basados en el número de cuentas, ayudándole a entender los costes asociados a sus necesidades particulares de integración.

Unipile ofrece una amplia documentación sobre la API de Gmail, incluida una guía para desarrolladores, referencias de API y tutoriales. Estos recursos son útiles para solucionar problemas y obtener consejos sobre las mejores prácticas para la integración de la API.