Google Maps API key for FeedSync
We recommend configuring a separate Google Maps API key for FeedSync.
In order to use Google Maps you need to have a billing account configured. See the Getting started with Google Maps Platform guide.
Once you have configured your billing and created your account login to your Google console.
Step 1: Create a new project #
We are assuming you have just completed the getting started steps and created a billing account above. If you already have a project skip to Step 2.
Select the project dropdown menu and create a new project.
It is a good idea to give your project a good name like {your website name} instead of the default My Project especially if you are managing a few different projects.
Enter in your project details and assign the billing account.
Once you have created your project select it.
Step 2: Enable Google API services for maps
From the project dashboard press the -> Go to APIs overview on the widget or from the main menu click API's & Services.
This screen provides you an overview of your API key usage so you can track what is happening and how that will impact your billing.
No services are enabled until you enable them. Lets enable 3 API services by pressing the + ENABLE APIS AND SERVICES.
Enable the following 3 services by searching, clicking on the API and pressing the enable button. Pricing is listed on each API page.
- Geocoding API (for fetching location coordinates)
- Maps JavaScript API (for displaying maps on websites)
- Places API (Advanced Maps uses this)
Repeat for each service.
Once all three API services are enabled we now need to create a key.
Step 3: Create an API key.
From the APIs & Services dashboard select Credentials from the menu.
On the next screen press + CREATE CREDENTIALS and select API key.
Copy and save the key (you can come back and get it) then close the box that displays the new API key.
Press the pen icon to edit the API key.
Rename the key to something that makes sense as you will have 2 keys. One for FeedSync and a separate one for WordPress. Name this one FeedSync and press save.
We will cover key restricting in Step 5, let's make sure this is working before we add restriction options.
Step 4: Add your API key to FeedSync
Login to your FeedSync installation and visit the Settings page, add your Google Maps API key and enable Geocoding and press save at the bottom of the page.
Visit the Help page and press Check Geocode Status to test your key.
The next screen will attempt to fetch coordinates using your key.
Often you will get an error here about billing. Make sure you have added Billing to your account. There are limits to the number of projects you can link to a single billing account.
Revisit your Google Console and select Billing from the main menu.
A billing account is REQUIRED for Google API services. Once you assign your billing account refresh the FeedSync Check Geocode Status page.
If your billing is all set you should have a green message.
Step 5: Restrict your API Key
You should now restrict the API key to your server's IP address so that your key can't be used on other websites. You do this from the previous step where you changed the name of the key.
From your Google Console select APIs & Services to view the dashboard.
This screen is from one of our FeedSync processing server accounts over a month of usage and with just under 20,000 requests we have not hit the limit for our account to be charged. FeedSync will only request coordinates ONCE per listing for the life of the listing as the listing's address doesn't change so there is no need to make further requests for that listing.
Select the Credentials menu then click the pen icon on your FeedSync labeled API key to access the key restriction settings.
Determine your server IP address. In cPanel this is listed on the right hand side as the Shared IP Address.
You can also use the ping command with in Windows command prompt or Mac Terminal. Omit the http info.
ping yourwebsite.com.au
Copy the IP address and add it to the IP address list and press save.
Visit the FeedSync Check Geocode Status page and refresh. IF you get an error you will see a bit of code e.g. in the message, add that as an additional IP address.
Press save and refresh the FeedSync Check Geocode Status page and you should see success!
Note: Once you press save in the Google Console the change can take a few minutes.
You have successfully added and restricted your FeedSync API key.