Accessing Google Drive via Rulex Platform#

This page explains how to access the content of a Google Drive account via Rulex Platform connection to Google REST API service.

To call the Google REST API a dedicated application needs to be created. At the moment, Rulex Platform supports the OAuth 2.0 refresh token authentication only. It requires therefore a refresh token to be used to issue an access token at any call.

To create a Google application you need the following:

Prerequisites

  • An account with Google cloud console access

  • A software to execute REST API call (to obtain the refresh token); we are going to use Postman in this guide.

First, you need to create a new project inside the Google cloud environment.

Procedure

  1. Go on the Google Cloud Console.

  2. Log in with your Google account.

  3. Select from the drop-down menu on the top side of the dashboard Select a project.

  4. Click on New project and follow the next steps to create it.

Then you need to enable the API of Google Drive to allow the new application to access the service:

Procedure

  1. Once the newly created project is selected, click on the Menu icon in the top left corner of the screen and go on the API & Services and then Enabled APIs and services.

  2. If you haven’t any enabled API yet, click on Enable api and services at the top of the screen.

  3. Then, search Google Drive API, select it and click on Enable.

  4. Go on the Credential tab by selecting it from the list on the left.

  5. Click on Create credentials and then select OAuth client ID.

  6. If requested, configure the Consent screen by clicking on Configure Consent Screen. If you own a Google Business user you can go for Internal user type to allow only users belonging to your organization, otherwise an External use needs to be enabled.

  7. Fill all the app information, for External it is required to use a verification before production approval. Do not pay a lot of attention to this procedure since we are not going to use the application of OAuth consent created here for the rest of the procedure. Fill only the mandatory fields and leave the default or empty for the others.

  8. If an External app is used, and you haven’t published yet, you should add your user to the list of Test Users.

  9. If the Consent screen operation is finished, go again on Credentials, click on Create credentials and then select OAuth client ID.

  10. Select Web application on the type of application.

  11. Name the OAuth 2.0 client just created and add the necessary authorized Authorised redirect URIs. To complete this guide please insert the Postman redirect uri https://oauth.pstmn.io/v1/callback. It will be useful later. Insert also https://localhost for Standalone Rulex Platform or your hostname in case of Rulex Platform cloud/server installation.

  12. Click on Create and then obtain the Client ID and the Client secret (you can download the json with this information inside by clicking on DOWNLOAD JSON).

The procedure below is meant to obtain the Refresh token and the Api key to be used inside Rulex Platform:

Procedure

  1. Go on the Credential tab by selecting it from the list on the left.

  2. Click on Create credentials and then select API key.

  3. The API key is going to be generated. To restrict its permissions, click on the three dots located on the right and click on Edit API key. In the provided panel you can restrict API key permissions.

  4. Open Postman application and configure a new Request.

  5. On the Authorization tab select OAuth2.0 authentication and look at the Configure New Token section. Fill the fields with the following values:

    • Callback URL: check on Authorize using browser.

    • Auth URL: https://accounts.google.com/o/oauth2/v2/auth?access_type=offline&prompt=consent

    • Access Token URL: https://oauth2.googleapis.com/token

    • Client ID: the client ID of the newly created application.

    • Client secret: the client secret obtained in the previous step.

    • Scope: https://www.googleapis.com/auth/drive

  6. Click on Get New Access Token and insert the user Google credential to complete the login procedure. If the app of Consent Screen is not verified, you need to click Continue on the provided Security warning. If needed, insert the MFA to complete the login procedure. It could be possible the Postman application would be flagged as insecure application as well as the final redirect popup would be blocked by your browser. In the latter case, please allow it to proceed.

  7. At the end, the Postman request will be authenticated. The refresh token will be in the Postman answer. Duration of the refresh token can be controlled on your Google account settings.

With the Refresh token and the Api key obtained in the last procedure, you are now ready to connect to Google drive via Rulex Platform interface. Necessary information is:

  • Api key

  • Client ID

  • Client Secret

  • Refresh token