Gmail API integratie gemakkelijk gemaakt: een uitgebreide gids.

Meld je aan op de Google Ontwikkelaars Console en maak een nieuw project aan of gebruik een bestaand Google-project.

Navigeer naar het gedeelte 'Credentials' in de Google Developers Console.
Maak 'OAuth Client ID'-referenties aan om toegang te krijgen tot je ingeschakelde API's:
Type toepassing: Webtoepassing
Naam: Je interne naam
Voeg 2 geautoriseerde redirect URI's toe:
https://{{YOUR_DSN}}/api/v1/hosted/google_auth_request_callback (je kunt je DSN vinden rechtsboven in Unipile Dashboard, voorbeeld https://api1.unipile.com:13211/api/v1/hosted/google_auth_request_callback
https://{{JOUW_DSN minder poort}}/api/v1/hosted/google_auth_request_callback/port{{JOUW_DSN minder domein}} (u vindt uw DSN rechtsboven in het Unipile Dashboard, bijvoorbeeld https://api1.unipile.com/api/v1/hosted/google_auth_request_callback/port13211

Klik op "CREATE
Client-ID en Client-geheim toevoegen aan Unipile Dashboard > Instellingen > Google OAuth

Ga naar de sectie 'Bibliotheek' in de Google Developers Console.
Vereiste API-bibliotheken inschakelen:
Zoek naar alle API-bibliotheken die je applicatie nodig heeft en schakel deze in: Gmail API

Tijdens de implementatie kun je je Google Project in verschillende toestanden houden:

Gebruikerstype' als 'Intern': In deze modus is je app beperkt tot Google Workspace-gebruikers binnen je organisatie.
Gebruikerstype' als 'Extern' & 'Publicatiestatus' als 'In test':
Opmerking: Als je 'In Test' bent, moet je testgebruikers toevoegen. Tokens verlopen na 7 dagen en gebruikers moeten zich opnieuw aanmelden.
Klik hier voor meer informatie over Publicatiestatus.
Voor meer informatie over gebruikerstypes, klik hier.

Zorg ervoor dat je het juiste gebruikerstype en de juiste publicatiestatus selecteert op basis van de test- en implementatiefase van je project.

Ga naar het gedeelte 'Ingeschakelde APIS en services' in de Google Developers Console.
Schakel API's in: Bekijk en controleer de volledige lijst met API's die u hebt ingeschakeld binnen uw Google Project.
Het Dashboard geeft een overzicht van alle ingeschakelde API's, zodat je de status van de geselecteerde API's voor je project kunt bevestigen. Gebruik dit gedeelte om ervoor te zorgen dat de benodigde API's zijn ingeschakeld voor een naadloze integratie met je applicatie.

Zorg ervoor dat de volgende informatie wordt verstrekt:

Voer uw applicatienaam in: Geef uw applicatienaam op.
E-mail voor gebruikersondersteuning: Neem een e-mailadres op waar gebruikers terecht kunnen met vragen over hun toestemming. Gebruik bij voorkeur een alias of een distributielijst waarin de relevante partijen zijn opgenomen.
Uw app-logo toevoegen: Upload het logo van je applicatie voor visuele identificatie.

Het invullen van deze informatie in het OAuth toestemmingsschermgedeelte is essentieel voor gebruikers om je applicatie te begrijpen en te vertrouwen tijdens het toestemmingsproces. Voeg nauwkeurige details en merkelementen toe voor een soepele gebruikerservaring.

Geef de volgende informatie op in de sectie App Domain:

URL startpagina toepassing: Voeg de URL voor de startpagina van uw applicatie toe.
Zorg ervoor dat het een echte homepage is en niet alleen een 'login'-pagina.
Koppeling naar privacybeleid van toepassing: Neem een link op naar het privacybeleid van je applicatie.
Belangrijk: zorg ervoor dat je juridische team het privacybeleid nakijkt om te voldoen aan Specifieke eisen van Googlemet name uit het gedeelte 'Beperkt gebruik' van het verstrekte document.
Servicevoorwaardenlink voor applicatie: Een koppeling naar de Servicevoorwaarden van je applicatie toevoegen.

Volg deze stappen om geautoriseerde domeinen toe te voegen:

• Voeg het gebruikte app-domein toe aan je Google Project. Zorg ervoor dat uw domein het productieniveau is en niet het dev/staging domein.
• Domein unipile.com toevoegen

• Voer een e-mailadres in:
  • Geef een e-mailadres op voor contactinformatie over de ontwikkelaar.
  • Belangrijk: Dit moet een distributielijst e-mailadres zijn, zodat alle relevante partijen Google Verification-gerelateerde e-mails en meldingen over wijzigingen in uw project ontvangen. Houd deze distributielijst up-to-date als teamleden komen en gaan.
• Controle na verificatie:
  • Houd het Google-project na indiening ter controle nauwlettend in de gaten op eventuele actiepunten van Google.
  • Opmerking: Google stuurt e-mails naar dit adres, maar deze kunnen in spammappen terechtkomen of door servers worden geblokkeerd. Controleer regelmatig op updates om te voorkomen dat u belangrijke berichten mist.

Zorg ervoor dat u een e-mailadres opgeeft dat actief wordt bewaakt en regelmatig wordt gecontroleerd om op de hoogte te blijven van de status van uw Google-project en eventuele vereiste acties na verificatie.

• Klik op de knop 'SCOPE TOEVOEGEN OF VERWIJDEREN' om het menu te openen.
• Voeg de volgende scopes toe (vernieuw de pagina als ze niet in de lijst verschijnen) :
  ./auth/gmail.send
  ./auth/gmail.labels
  ./auth/gmail.alleen-lezen
  ./auth/gmail.modify (niet nodig als je geen e-mail wilt verplaatsen of verwijderen. Je moet Google laten zien dat je het echt gebruikt. Informeer ons om het handmatig van uw Unipile-account te verwijderen)

Je mag pas verder gaan met deze stap als je integratie volledig is voltooid en operationeel is in productie.

Maak en host een demonstratievideo die voldoet aan de voorwaarden van Google. Om je app bij Google te valideren, moet je ook een video indienen waarin de functionaliteit van je app wordt getoond. Deze video moet worden geüpload als een 'Unlisted' YouTube-video voor verificatiedoeleinden en er is slechts één videolink toegestaan.

• Uw app en OAuth-stroom worden in het Engels weergegeven, zoals aangegeven in de documentatie van Google onder "Apps requesting sensitive scopes" en "Apps requesting restricted scopes".
• De demonstratie wordt uitgevoerd in een domein op productieniveau.
• Navigeer in je Google Project instellingen naar Navigatiemenu -> API's & Services -> OAuth Toestemmingsscherm en bevestig het volgende:
  • Publicatiestatus is ingesteld op "In productie".
  • Gebruikerstype wordt aangeduid als "Extern".

• Geef de startpagina van je applicatie weer met de volledige URL en benadruk de productiestatus.
• Illustreren hoe een Google-klant zijn account kan koppelen met de nadruk op het gebruik van de officiële aanmeldknop van Google.
• Markeer tijdens de verificatiestroom, wanneer het OAuth-processcherm wordt weergegeven, de URL en sleep deze naar de overkant om de CLIENT ID in de URL weer te geven.

• Laat achtereenvolgens elke set scopes zien die wordt aangevraagd, door ze aan te passen aan je specifieke gebruikssituatie.
• Demonstreer bidirectionele functionaliteit door synchronisatie tussen jouw applicatie en Gmail te laten zien. Gebruik aparte tabbladen om te schakelen tussen jouw applicatie en elk relevant onderdeel van Gmail. Bijvoorbeeld, een e-mail verzenden via je applicatie, illustreren hoe wijzigingen worden gesynchroniseerd in Verzonden mail lijst op Gmail, en op de andere manier de ontvangst van een inkomende e-mail binnen je app weergeven.

Als je deze richtlijnen volgt, zal je demonstratievideo het authenticatieproces en de functionele mogelijkheden van je applicatie in sync met Google-services effectief overbrengen.

Nadat je je videodemo hebt gemaakt en hebt gecontroleerd of deze aan alle criteria voldoet, kun je de YouTube-video URL met ons delen. Wij kunnen je helpen bij het beoordelingsproces of je kunt je app direct ter verificatie indienen.

Let op de volgende stappen:

• Voeg de uiteindelijke video toe aan je Google Project als een 'unlisted' YouTube-videolink.
• Stuur de URL van de YouTube-video ter controle naar uw Customer Success Manager.
• Ga na de beoordeling verder met het indienen van de app-verificatie.

Houd er rekening mee dat de duur van het verificatieproces kan variëren. Na indiening kan het 2 tot 8 weken duren, afhankelijk van de indieningswachtrij van Google en het aantal herstelrondes dat zij nodig achten. Blijf op de hoogte en coördineer met ons tijdens het verificatieproces.

Als je applicatie beperkte scopes gebruikt, zijn er extra stappen nodig. Hier volgt een kort overzicht van wat u moet verwachten:

Google Beveiligingsbeoordeling
Om de veiligheid van gebruikersgegevens te garanderen, moeten apps die toegang vragen tot Google-gebruikersgegevens met een beperkte reikwijdte een beveiligingsbeoordeling ondergaan. Deze beoordeling is cruciaal om te controleren of alle apps die toegang hebben tot Google-gebruikersgegevens veilig met gegevens kunnen omgaan en gebruikersgegevens op verzoek kunnen verwijderen. Het gedetailleerde beoordelingsproces wordt beschreven op de CASA-site (Cloud Application Security Assessment).

Google categoriseert je app als Tier 2 of Tier 3

Niveau 2 (zelf gescand - laboratorium geverifieerd) >> Meest voorkomend
Optie: gratis OF betaald (derde partij)
CASA Niveau 2 Proces
Niveau 3 (laboratorium gescand - laboratorium geverifieerd)
Betaald - Moet worden ingevuld door een externe beoordelaar
Na ontvangst van uw Tier-classificatie geeft Google instructies en tools voor het voltooien van de beoordeling. Raadpleeg de koppeling voor informatie over de Google-beveiligingsbeoordeling en scroll naar beneden naar de Veelgestelde vragen over de beveiligingsbeoordeling voor meer gedetailleerde informatie. Zorg ervoor dat u voldoet aan dit proces om aan te tonen dat uw app veilig kan omgaan met gebruikersgegevens wanneer u beperkte scopes gebruikt.

Informatie over het Google-beveiligingsonderzoek

Jaarlijkse herbeoordeling van beveiliging voor apps met beperkte reikwijdte
Apps die toegang hebben tot beperkte scopes moeten een jaarlijks herverificatieproces ondergaan voor naleving en elke 12 maanden een beveiligingsbeoordeling voltooien om toegang te houden tot geverifieerde beperkte scopes. Dit proces zorgt ervoor dat de beveiligingsnormen voortdurend worden nageleefd en dat gebruikersgegevens worden beschermd.

Als je op een bepaald moment een nieuwe beperkte reikwijdte introduceert die nog niet eerder is beoordeeld en goedgekeurd, moet je app op dat moment mogelijk opnieuw worden beoordeeld.

Het Google reviewteam neemt via e-mail contact op wanneer het tijd is om uw app opnieuw te certificeren. Het is cruciaal om de informatie over uw Projecteigenaar en Projecteditor up-to-date te houden in uw Cloud Console. Dit zorgt ervoor dat de juiste leden van uw team meldingen ontvangen over deze jaarlijkse handhaving, zodat u tijdig en soepel kunt voldoen aan de vereisten voor herbeoordeling. Blijf waakzaam en reageer direct op communicatie van Google om de beveiliging en compliance van je app te handhaven. Bekijk de FAQ van Google voor meer informatie.

Whitelisting-optie
Als je de voorkeur geeft aan een alternatief voor de standaard verificatie- en beveiligingsbeoordelingsprocessen, heb je de mogelijkheid om je aanvraag te laten whitelisten. Hiermee kunt u de gebruikelijke procedures omzeilen, maar het is belangrijk op te merken dat deze optie alleen van toepassing is als uw toepassing aan zeer specifieke criteria voldoet. Hoewel de meeste use cases niet aan deze criteria voldoen, hebben we de vereisten hieronder uiteengezet zodat u kunt beoordelen of whitelisting geschikt zou kunnen zijn voor uw toepassing.

Vereisten:

De meeste klanten gebruiken Google Workspace:
De meerderheid van je klanten zou Google Workspace (voorheen GSuite) accounts moeten gebruiken, d.w.z. e-mailadressen hebben met de indeling @company.com.
Whitelisting vereist actie van de beheerders van eindgebruikers om toegang te verlenen. Je moet de beheerders van je gebruikers je Google projet Client ID geven. Ze moeten hun Console: https://admin.google.com/ac/owl/list?tab=configuredApps openen en je client_id toestaan.
Beperkt persoonlijk gebruik van Gmail-account:
Minder dan 100 persoonlijke Gmail-accounts (@gmail.com-adressen) moeten zich kunnen verifiëren in deze stroom.
Niet-gevalideerde projecten hebben een limiet van 100 (lifetime) gebruikers per project. Wanneer Google Workspace-accounts in de witte lijst zijn opgenomen, tellen ze niet mee voor deze limiet. Persoonlijke Gmail-accounts tellen echter altijd mee voor deze limiet.
Gratis testgebruikers en whitelisting:
Gratis proefgebruikers moeten hun Workspace e-mailadres gebruiken en de applicatie whitelisten.
Houd er rekening mee dat whitelisting een workaround-oplossing is en mogelijk niet geschikt is voor alle use cases. Evalueer deze vereisten zorgvuldig om te bepalen of uw toepassing voldoet aan de criteria voor whitelisting. Zo ja, neem dan de nodige stappen om aan deze vereisten te voldoen en onderzoek deze alternatieve aanpak.

De Gmail API is specifiek ontworpen voor interactie met Gmail-accounts en integreert niet direct met andere e-mailclients of -services. Ontwikkelaars kunnen de API echter gebruiken om e-mails te synchroniseren of te migreren van of naar Gmail, en vervolgens interacties afhandelen met niet-Gmail clients via hun respectievelijke API's of protocollen zoals IMAP of SMTP.

De Gmail API houdt zich aan het strikte privacybeleid van Google en aan regelgeving zoals GDPR. Toestemming van de gebruiker is verplicht en applicaties moeten OAuth 2.0 gebruiken voor verificatie en autorisatie, zodat gebruikers expliciet toestemming geven voor toegang tot hun Gmail-accounts. De toegang van de applicatie is beperkt tot wat nodig is voor de functionaliteit en gebruikers kunnen op elk moment de toegang intrekken.

De kosten voor het gebruik van de Gmail API zijn afhankelijk van het aantal gebruikersaccounts dat via jouw applicatie verbonden is. Ga voor specifieke prijsinformatie naar de Prijzen op de website van Unipile. Hier vind je details over de verschillende prijsniveaus op basis van het aantal accounts, zodat je inzicht krijgt in de kosten die gepaard gaan met jouw specifieke integratiebehoeften.

Unipile biedt uitgebreide documentatie over de Gmail API, inclusief een gids voor ontwikkelaars, API-referenties en zelfstudies. Deze bronnen zijn handig voor het oplossen van problemen en het krijgen van advies over best practices voor API-integratie.