Google mail, contacts, and calendar
PDF

Register Creatio application in G Suite

Products
All Creatio products

G Suite registration procedure can be divided into two steps:

  • Register a Google account and set it up, enable access to the API, and generate the keys required for integration (“Client ID” and “Client Secret”).

  • Use the values of the “Client ID” and “Client Secret” keys to populate the [Google Service Access Key] and [Google Secret Access Key] Creatio system settings respectively.

For security reasons, we recommend enabling two-factor authentication for Gmail accounts and using app passwords to access your mail. Read more in the Google Help Center.
To test this functionality, you can turn on “less secure app access” in your Gmail account as a temporary solution. Read more in the Google Help Center.

Set up an account and receive Google keys 

Note. When you transfer to version 7.17.1, create an OAuth 2.0 client ID with a new redirection address.

To configure your Google account:

  1. Follow the https://code.google.com/apis/console/ link.

  2. Log in as a G Suite administrator.

  3. Open the API library and use the search bar to find Gmail API.

    Accessing Gmail API
    ""
  4. Go to the Gmail API page and click Enable.

    Enabling Gmail API
    ""

     

  5. Repeat steps 3 and 4 to enable Contacts API and Calendar API.

    As a result, both APIs are added to the list of available APIs (Fig. 3).

    Fig. 3 The list of available project API
    ""
  6. Specify the information about the product to create the client ID. In the [API Manager] menu, click [Credentials] (Fig. 4).

    Fig. 4 Opening the Credentials setup page
    ""
  7. Specify API parameters:

    1. Select Gmail API in the [Which API are you using?] drop-down menu.

    2. Select Web-browser (Javascript) in the [Where will you be calling the API from?] drop-down menu.

    3. Select User data in the What data will you be accessing? field.

      Click What credentials do I need? (Fig. 5).

      Fig. 5 Adding credentials to your project

       

      ""
  8. Create an OAuth client ID

    1. Specify the name of the product in the Name field to show to the Creatio users during authorization for using Google accounts.

    2. Enter your Creatio website address in the Authorized JavaScript origins field.

    3. Populate the Authorized redirect URLs field with links formatted as follows:

      For Creatio version 7.17.0 or lower::
      https://your_website_address/0/ViewPage.aspx?Id=3b22f0ff-034a-48da-8758-a0660e5a26ff

      https://your_website_address/0/rest/GoogleOAuthAuthenticator/ProcessAuthenticationCode
      For Creatio version 7.17.1 and up:
      https://your_website_address/0/LegacySocialAccountAuthPage.aspx?Id=3b22f0ff-034a-48da-8758-a0660e5a26ff
      https://your_website_address/0/rest/GoogleOAuthAuthenticator/ProcessAuthenticationCode

      Click Create an OAuth client ID (Fig. 6).

      Fig. 6 Creating OAuth client ID
      ""

       

    As a result, Google will suggest to set up an OAuth consent screen. Click [Set up consent screen] to proceed.

  9. Specify the required parameters in the OAuth consent screen:

    1. The name of the application that requires access

    2. Support service email address

    3. Authorized domains

    4. Link to the main page of the application

    5. Link to the privacy policy of the application.

      Click Save.

  10. Go back to the credentials page. Refresh the page. As a result, the Create OAuth client ID button will become available. Click the button to create your “Client ID” and “Client Secret”.

  11. Enter your Google keys (Fig. 7) in the corresponding system settings in Creatio.

    Fig. 7 Google keys
    ""

     

Enter a Google key in Creatio 

Enter Google keys to synchronize with contacts and calendar 

Enter the received “Client ID” and “Client Secret” keys into Creatio for the values of the [Google Service Access Key] and [Google Secret Access Key] system settings. To do this:

  1. Open the Creatio application.

  2. Open the System Designer by clicking btn_system_designer.png in the top right corner of the application window.

  3. Click System settings in the System setup block (Fig. 8).

    Fig. 8  The System settings section
    ""
  4. Select the “Google services access key” system setting in the list and click Open.

  5. Populate the Default value field of the system setting page with your client ID that you retrieved during the Creatio registration in Google (available in the Here is your client ID field in the Google API message).

  6. Select the “Google secret access key” system setting in the list and click Open.

  7. Populate the Default value field of the system setting page with your client secret key that you retrieved during the Creatio registration in Google (available in the Here is your client secret field in the Google API message).

    As a result, users will be able to synchronize their mail, tasks, and contacts with their Google calendar and Google contacts.

Enter Google keys to synchronize with email 

Enter the received “Client ID” and “Client Secret” codes in Creatio when setting up the secure OAuth 2.0 connection for the Gmail provider. To do this:

  1. Open the Creatio application.
  2. Open the System Designer by clicking btn_system_designer in the top right corner of the application window.
  3. Go to the System setup] block –> click Lookups.
  4. Select the List of email providers lookup.
  5. Open Gmail provider settings.
  6. In the Additional settings area, specify the OAuth 2.0 authentication method. This enables limited access of the email service to the user protected resources and does not require login and password. 
  7. Specify the “Client ID” and “Client Secret” codes that you received earlier in the Application client ID and Client secret required fields.
    Setting up OAuth 2.0 for Gmail
    ""
  8. Save the email provider settings.