CareFree Knowledge Base

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Google Maps API Key for CareFree ======
Google have made changes to the interface (called an API) which allows products like CareFree to query distance and travel information and to display maps.  They have also changed the terms and conditions for using these services and have made it mandatory to enter payment details should customer wish to continue using their services.  (They have stated that they expect the service to remain free for the vast majority of users, but they have said that everyone must create a payment account in case free usage limits are exceeded.)

In order to continue using Google Maps for mileage calculations you must create an API with a linked payment account and then use our temporary mileage calculation app until we can upgrade your CareFree database.

===== Creating an API Key =====
An API Key must be created for CareFree to make any mileage requests. Once the API Key has been created this must then be entered in your CareFree system. The next 2 sections of this guide will explain how to do this.

1. Go to the link [[https://cloud.google.com/maps-platform/?apis=maps,routes,places|https://cloud.google.com/maps-platform/?apis=maps,routes,places]]

{{ :wiki:2018-10-19_08h51_01.png?600 |}}

2. You will notice that **Maps**, **Routes** and **Places** will already be selected

3. Click **Continue**

{{ :wiki:2018-10-16_11h03_20.png?400 |}}

4. Log into your Google account\\ <WRAP center round tip 100%>
If you have forgotten your email/password click Create Account to create a new Gmail account
</WRAP>

5. Once you have signed into Google you will be redirected back to the first screen now stating that you are now signed in

{{ :wiki:2018-10-19_08h57_33.png?600 |}}

6. Click **Continue**

7. You will then be asked to create a project. The new project name will named as **My Project** which can be left as is

{{ :wiki:2018-10-16_11h18_47.png?400 |}}

8. Ensure you select **Yes** to agree to the terms and conditions 

9. Click **Next** to continue

{{ :wiki:2018-10-16_11h22_15.png?400 |}}

10. The next page will ask you to create a billing account. Click **Create Billing Account**

<WRAP center round important 100%>
**Please note: Billing information must be entered to allow mileage requests using the API key. You will only be charged if you go over the amount of requests included with your Google API Key (you are given 40,000 requests a month).\\  
\\ 
Remember that once CareFree has queried a journey once, the distance and travel time are stored within the database so queries are only sent to google for new journeys on the rota.  For example when new clients are added into the system.**
</WRAP>

{{ :wiki:2018-10-16_11h53_03.png |}}

11. Tick to say you have read the terms and conditions 

12. Select either Yes or No if you would emails from Google regarding feature announcements, performance suggestions, feedback surveys and special offers

13. Click **Agree and Continue**

{{ :wiki:2018-10-16_11h53_57.png |}}

14. Enter all the appropriate fields on this screen including your business information, contact information and payment method

<WRAP round important 100%>
**We advise using card details since some customers have reported issues when using bank details**
</WRAP>

15. At the bottom of the page click **Start My Free Trial** to create the account

{{ :wiki:2018-10-16_11h49_57.png |}}

16. A prompt will then appear to enable your API key

{{ :wiki:2018-10-16_11h59_33.png?400 |}}

17. Click **Next**

18. A prompt will then appear with your API Key ready to be copied into CareFree

{{ :wiki:2018-10-16_12h09_03.png?400 |}}

19. Ensure the API Key is copied then click **Done**

===== Entering the API Key into CareFree =====
This section of the guide will explain how to enter your API Key into CareFree.

1. Open CareFree and log in as an administrator

2. Go to **Tools**, click **Options and Settings** then click **Shared Options**

{{ :wiki:2018-10-16_12h16_59.png?500 |}}

3. Click into the **Mileage** category on the left

4. Paste the API Key in the field named **GoogleMaps API Key**

{{ :wiki:2018-10-16_12h24_41.png |}}

5. Click **OK** to save this setting

<WRAP center round important>
**If you are running CareFree version 5.5.7 please ignore the Running Google Maps Fix section below**
</WRAP>

===== Running Google Maps Fix =====

This section of the guide will explain how to use the Google Maps Fix file to search for any bad postcodes/routes in your CareFree system. A bad postcode/route is something Google Maps is unable to search for, for example, this may be down to the postcode being entered incorrectly or the postcode being a new road.

1. a. For Non-Hosted Customers - Open the EXE file sent to you by CareFree. The file will be named something along the lines of GoogleMapsFix.exe
\\ {{ :wiki:2018-10-16_12h29_23.png |}}

1. b. For Hosted Customers - Open the same file but from your [[https://hosted.carefreeapp.co.uk/RDWeb|IGC Login Webpage]]

{{ :wiki:2018-10-17_15h17_22.png |}}

2. You will be asked for a password, this can be provided by the CareFree Support Team (01924 667 598)

{{ :wiki:2018-10-16_12h31_46.png |}}

3. The page that appears will be split into 2 sections

{{ :wiki:2018-10-16_14h15_00.png |}}

4. Use the left-hand side of the screen to search for any bad postcodes in your CareFree system

5. Click the **Locations** button to start this search

{{ :wiki:2018-10-16_14h25_212.png |}}

6. If there any bad postcodes in your CareFree system they will be listed here\\ //For example, the postcodes listed above either have too many letters/numbers, a letter O has been entered instead of a zero or the postcode is not yet recognised by Google Maps (i.e. if the postcode is a new road)//

7. If you wish to change these bad postcodes you need to do so from your CareFree system

8. Use the right-hand side of the screen to search for any bad routes in your CareFree system

9. Use the **Date range** fields to enter a start date and end date of routes you wish to search through

10. Click the **Route** button to start this search

{{ :wiki:2018-10-16_15h34_24.png |}}
CareFree Knowledge Base

User Tools

Site Tools

Page Tools
