Set up a Google API key

What this article helps you do

Add and test your Google Maps API key in Mapstore. This key gives Mapstore access to Google Places and Google Geocoding.

Before you start

• You have a Google Cloud project.
• Billing is enabled for the project. Billing is necessary for Google Maps APIs.
• You can enable APIs in the Google Cloud Console.

Video walkthrough

Use this short video to see the API configuration procedure:

Step-by-step instructions

1. Create or use an API key

1. In Google Cloud Console, open your project.
2. Go to APIs & Services -> Credentials.
3. Create an API key (or use an existing one).
4. In API restrictions, permit access only to Places API (New) and Geocoding API.

Mapstore sends these requests from its server. Do not use a Websites or HTTP referrer application restriction. That restriction applies to API calls from a shopper browser. An IP restriction operates only for IP addresses on its allowlist. Before you add an IP restriction, contact Mapstore support.

2. Enable the required APIs

1. Go to APIs & Services -> Library.
2. Enable these APIs:
   • Places API (New) - for ratings, review counts, and business hours
   • Geocoding API - for address lookup and bulk geocoding

Make sure you enable Places API (New), not the legacy “Places API”.

3. Add the key to Mapstore

1. In Mapstore, go to Settings.
2. Find Google Maps integration.
3. Paste your API key.
4. Click Test API key.

4. Interpret the test result

The test checks the two APIs:

• Both pass - The two APIs passed the test. Ratings, hours, and geocoding operate.
• Partial pass - One API failed. The result identifies the API that failed.
• Both fail - The key can be incorrect or restricted. One or two APIs can be disabled.

5. Fix a failed test

If the test fails, check these items before creating a new key:

1. Make sure that the key and the two required APIs use the same Google Cloud project.
2. Make sure that billing is enabled for your project.
3. Check API restrictions. If the key has API restrictions, permit access to the two required APIs.
4. Remove website and HTTP referrer restrictions.
5. If the key uses an IP restriction, include the Mapstore server IP in the restriction.
6. Copy the full key again with no other spaces.
7. If a timeout occurs, do the test one more time.
8. If a second timeout occurs, check the network and firewall rules.

How to verify it worked

1. Click Test API key.
2. Make sure that you see a green success message.
3. Import a store that has a correct address but no coordinates.
4. Make sure that Mapstore adds coordinates to the store.
5. Sync a store that has a Google Place ID.
6. Make sure that the rating, review count, and hours load.

Troubleshooting

Related articles

• Show Google ratings and hours
• Fix stores without map coordinates