XtremeCRM uses Google for addresses and maps: the suggestions that appear as you type an address, placing each address on the map (which also drives sales tax by address), directions to a customer, and drive times in the web scheduler. All of that runs on your own Google key, from a Google Cloud project that your business owns and that bills to your own Google account.
If the key stops working, administrators see a Google Maps key banner at the top of XtremeCRM. This article shows how to set the key up, and how to fix it when the banner appears.
What the key needs
Turn on all of these APIs in your Google Cloud project, on the same key:
| Google API | What it does in XtremeCRM |
|---|---|
| Places API (New) | Address suggestions while you type an address |
| Geocoding API | Places each address on the map, and finds its county |
| Routes API | Directions to a customer, and drive times for web scheduler bookings |
| Directions API | Directions to a customer (older projects only) |
| Distance Matrix API | Drive times (older projects only) |
Google no longer lets new projects turn on the Directions API or the Distance Matrix API. If yours can't, that's fine: XtremeCRM uses the Routes API instead.
You don't need the Maps JavaScript API or any map tile API. XtremeCRM's map doesn't use them.
Set up a new key
- Go to console.cloud.google.com and sign in with the Google account that should own the key. Write down which account this is: you'll need to sign in with it again to make changes later.
- Create a project for XtremeCRM (or pick the one you already use) from the project picker at the top of the page.
- Open Billing and link a billing account to the project. Google refuses every API on a project without billing, even inside its free monthly allowance. You're only charged for use beyond that allowance; see Google Maps Platform pricing.
- Open APIs & Services → Library. Search for each API in the table above and click Enable.
- Open APIs & Services → Credentials, click Create credentials → API key, and copy the key.
- Click the new key to edit it. Under API restrictions, choose Restrict key and tick each API from the table. Leave Application restrictions set to None: XtremeCRM calls Google from its own servers. Click Save.
- Optional but recommended: open APIs & Services → Quotas and set a daily cap on each API's requests, so a busy month can't run past Google's free usage into a bill.
- In XtremeCRM, an administrator opens Maintenance → Google Maps and pastes the key. (Once saved, the page shows only the key's last four characters; to change it, click Replace key and paste the new one.) Enter the Google account that owns the project, then click Test key. When every API shows a green check, click Save. Or send the key to us in a support chat (Help → Support → New chat) and we'll put it in for you.
Recording the account matters: Google won't tell anyone who owns a key, so it's how you (or we) know whose console to sign in to when the key needs changing. Open Google Cloud console on the same page takes you straight to the project.
Use one key for your business. Splitting your usage across several Google accounts or projects to stay inside the free allowance is against Google's terms, and Google can suspend all of them.
Test your key
Maintenance → Google Maps → Test key asks each Google API XtremeCRM uses whether it accepts your key, and shows the answer for each one:
- Working: nothing to do.
- Not enabled: enable it under APIs & Services → Library.
- Billing isn't turned on: link a billing account under Billing.
- Google doesn't recognize this key: the key was mistyped or deleted; copy it again or create a new one.
- The key's restrictions block this API: add the API to the key's API restrictions, and set Application restrictions to None.
- Not needed: the Directions API or Distance Matrix API (older projects only) isn't on. That's fine: XtremeCRM uses the Routes API instead.
The test also fills in your project's number when Google names it, and ticks off the setup checklist on the same page.
Fix the "Google Maps key" banner
The banner says what Google refused. The usual fixes, in order:
- Start with Test key on Maintenance → Google Maps: it says exactly which API Google is refusing and why.
- "no Google Maps key is set up": follow Set up a new key.
- "Google rejected this company's Google Maps key": sign in to the Google Cloud console with the account that owns the project, then check that:
- the project still exists and isn't suspended;
- Billing shows a linked billing account in good standing;
- the key still exists under APIs & Services → Credentials. If it was deleted, create a new one and save it in XtremeCRM.
- "…for address suggestions": the Places API (New) isn't on. Enable it under APIs & Services → Library, and add it to the key's API restrictions if the key has any.
- "…for map locations": the same for the Geocoding API.
- "…over its usage limit": Google paused the key for quota. Check APIs & Services → Quotas, or wait for the limit to reset.
Google can take a few minutes to apply a change. XtremeCRM checks the key again within about ten minutes, and the banner goes away the next time you sign in after the key works.
Questions
Not sure which Google account owns your project, or want us to walk through it with you? Start a chat or book a meeting from Help: see Getting help in XtremeCRM.