User Tools
google_maps_api_key_for_carefree
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
google_maps_api_key_for_carefree [2018/10/16 16:55] cfadmin |
google_maps_api_key_for_carefree [2021/09/22 10:32] dominich |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Google Maps API Key for CareFree ====== | ====== Google Maps API Key for CareFree ====== | ||
| - | [Place introduction for the need of this training documentation]. | + | 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 ===== | ===== 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. | 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|https://cloud.google.com/maps-platform/?apis=maps,routes]] | + | 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-16_11h01_01.png?400 |}} | + | |
| - | 2. You will notice that **Maps** and **Routes** will already be selected | + | {{ :wiki:google_maps_start.png?600 |}} |
| - | 3. Click **Continue** | + | 2. Click **Sign In** in the top right |
| - | {{ :wiki:2018-10-16_11h03_20.png?400 |}} | + | {{ :wiki:google_developer_sign_in.png?400 |}} |
| 4. Log into your Google account\\ <WRAP center round tip 100%> | 4. Log into your Google account\\ <WRAP center round tip 100%> | ||
| Line 21: | Line 21: | ||
| 5. Once you have signed into Google you will be redirected back to the first screen now stating that you are now signed in | 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-16_11h11_59.png?400 |}} | + | 6. Click **Get Started** |
| - | 6. Click **Continue** | + | {{ :wiki:google_get_started.png |}} |
| - | 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 | + | 7. You will then be asked to agree to the Google Cloud Platform Terms of Service. Tick to agree and press **Continue**. |
| + | |||
| + | {{ :wiki:google_terms_of_service.png?400 |}} | ||
| + | |||
| + | 8. Confirm your Indentity Verification and Contact Information. Press **Continue** to accept. | ||
| + | |||
| + | 9. The next page will ask you to add payment information for a billing account. Click **Start my Free Trial** when complete | ||
| + | |||
| + | {{ :wiki:2018-10-16_11h49_57.png |}}\\ | ||
| + | |||
| + | <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> | ||
| + | |||
| + | 10. Confirm details about your business to enable the maps platform. Press **Submit** to continue. | ||
| + | |||
| + | {{ :wiki:google_enable_platform.png?400 |}} | ||
| + | |||
| + | 11. The next page will display your API key. Make a note of this or click the copy icon. Click **Maybe Later** at the bottom of the screen. | ||
| + | |||
| + | {{ :wiki:google_api_key.png?400 |}} | ||
| + | |||
| + | 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 |}} | {{ :wiki:2018-10-16_11h18_47.png?400 |}} | ||
| Line 54: | Line 78: | ||
| 14. Enter all the appropriate fields on this screen including your business information, contact information and payment method | 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 | 15. At the bottom of the page click **Start My Free Trial** to create the account | ||
| Line 78: | Line 106: | ||
| 2. Go to **Tools**, click **Options and Settings** then click **Shared Options** | 2. Go to **Tools**, click **Options and Settings** then click **Shared Options** | ||
| - | {{ :wiki:2018-10-16_12h16_59.png?500 |}} | + | {{ :wiki:shared_options.png |}} |
| 3. Click into the **Mileage** category on the left | 3. Click into the **Mileage** category on the left | ||
| Line 88: | Line 116: | ||
| 5. Click **OK** to save this setting | 5. Click **OK** to save this setting | ||
| - | ===== 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]] | ||
| - | |||
| - | 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 |}} | ||
google_maps_api_key_for_carefree.txt · Last modified: 2021/09/22 10:58 by dominich
Page Tools
