Integrating ePASS with Google Maps API

EPASS Support

23-Nov-2022

ePASS integrates with the Google API for our mapping features. To use the Google API, you must sign up for your own Google Cloud account and provide certain API details in the ePASS configuration.

As of Nov 2021, Google provides $200 worth of free transactions per month. It is unlikely that your company will surpass this.

Prerequisites:

1. You need a Google account (ie, a gmail.com email address). You can sign up here: https://accounts.google.com/SignUp
2. Your Google account must be linked to a Google Cloud account, with Billing enabled (you must provide a credit card number). Follow the steps at this link: https://console.cloud.google.com/billing

Creating the ePASS Mapping Project

First you will need to create the Mapping Project that will be used by ePASS to access the API.

1. Login to your Google account and go to this link: https://console.cloud.google.com/projectselector2/home/dashboard
2. Click CREATE PROJECT.
3. For the in the Project name field, type “EPASS Mapping”. Leave the Location field set to “No organization”.
4. Click CREATE.

Enabling the APIs

Now that you’ve created the EPASS Mapping Project, Google will bring you to the dashboard for the project. If you need to get back here, you can access it via the toolbar.

1. From the project dashboard, click APIs and services > Library.
2. Use the search form and type in “Maps JavaScript API”. Locate and click ENABLE.
3. You will be returned to the API page. Under Additional APIs, open and ENABLE the following additional APIs:
   • Directions API
   • Distance Matrix API
   • Geocoding API
   • Maps Static API
4. Confirm that under APIs > Enabled APIs, you see all give APIs listed.

Copying the API Key

Now that the required APIs are enabled, we need to generate the API Key for EPASS.

1. From within the EPASS Mapping project, click Credentials.
2. Click CREATE CREDENTIALS > API key.
3. The key will be generated. Click the copy icon to copy it to the clipboard. Paste the key to an email or Word doc to keep it safe.
4. Click Close.

Setting up the API Key in EPASS

Now that we have the API key, we need to set it up in EPASS so that the integration will function.

1. Login to EPASS.
2. Go to System Maintenance > Variables > Dispatching.
3. Paste the API Key into the Google Mapping API Key field.
4. Click OK.
5. Restart EPASS.

The integration is now configured and should be tested.