---
title: "Map API Configuration Utility"
canonical: "https://kb.myframeworks.com.au/space/FRAM/28405302/Map%20API%20Configuration%20Utility"
format: markdown
---
# Overview

The **Map API Configuration Utility **allows you to apply the API key required for the connection to **Google Maps** (most commonly used), **MapQuest** or **DataCom** to your Frameworks. The map API key is a unique identifier that authenticates requests associated with your Frameworks allows you to display a map within Frameworks.  

The current Google Maps API's in use are the following:

- Directions API (Transport Scheduling)
- Distance Matrix API (Transport Orders)
- GeoCoding API (assign latitude and longitude to all orders)
- Maps Embed API (Sales orders and Transport Orders)

> ⚠️ **Important: ** You must configure the required API key before using the **Map API Configuration Utility. **See [Generating a Google Maps API Key](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28401830) to add a Google Maps to Frameworks. For MapQuest and DataCom please contact [Sterland Support](https://kb.myframeworks.com.au/page/support) for assistance.
> ⚠️ 
> ⚠️ Available in version 5.14 (r&d)+ If you are running an earlier version please contact [Sterland Support](https://kb.myframeworks.com.au/page/support) with API Key.

> ℹ️ This document will explain the process of applying a Google Maps API key to Frameworks.

# Adding and Testing a Map API in the Configuration Utility

To add and test your Map API key,** **perform the following:

1. Click the **Frameworks Menu**, then navigate to **System Administration > System Tables > Map API Configuration Utility **from the navigation tree.
2. The **Map API in the Configuration Utility **popup window will be displayed. This window is broken down into 2 sections
  - The API details.
  - The Test Results.
3. From the **Active API Type** drop-down menu, select **Google Maps**
4. In the **Test Address **field will be displayed the default branch address. If required, you can edit the test address to any address.
5. In the **Google API** field, paste in the **API key** generated in your Google Cloud account

> ✅ Refer to the [Generating a Google Maps API Key](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28401830) Administrators Guide for more information.

6. Click **Save and Test Google API** to save and test the Google Maps API detail. If configured correctly, the results will be displayed below.

![image](media://8c46d8d1-bd98-4742-b78c-906e9b615d32)

7. Click **Save **to save and close the window.

# Additional Information

> ✅ Refer to the [Generating a Google Maps API Key](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28401830) Administrators Guide for more information.