Address Lookup is a core part of the ShareDo system. We support this across the platform in several places, including setting and updating different address types on an ODS Record, and creating or updating ODS Locations.
The ‘Adapter Pattern’ Approach
ShareDo currently supports the following providers for Address Lookup,
We currently support the following providers. Click the images to go to their websites.
 |
|
|
This can be extended. If you are interested in a specific provider, please contact ShareDo's Professional Services team.
Address Lookup Functionality
After Selecting a Location Type in ShareDo, you can then use the Find Address field to look up the address using the predefined provider.
Once selected, the Address you look up populates the remaining fields with the full qualified address data;
Configuration for each Provider
Loqate
Configure ShareDo to use Loqate for Address Lookup
To perform an Address Lookup in ShareDo, you must first configure a provider. Below are the instructions for configuring Loqate as an Address Lookup provider.
Loqate comes preinstalled out of the box for ShareDo customers
Configure API Key for Loqate
You need to provide an API Key to use the Loqate Service. You can set this up from your Loqate account. If you do not already have a Loqate Account, register here.
- Login to your Loqate Account > Your Services screen > + Add a service
- From the next screen Select API Key;
- The Loqate Service will now instantly create you an API Key, (hidden behind the red tab in the next screenshot). Make sure you note this key down to be used later.
- In the Configuration Tab, you can Name the API Key
- From the Limits Tab, it is possible for you to restrict the API Key so that it can only be used when the request originates from specific URL's, or from specific IP Addresses. It is also possible to limit the key to a capped daily spend.
Configure Address Lookup for Loqate in ShareDo
You are now ready to use the API Key in your ShareDo Application.
Within Modeller > Global Features, navigate to Address Lookup, ensure it is enabled.
Click the Cog icon to configure the Settings.
| Setting | Description |
|---|---|
| Address Query Delay | When a user stops typing into the address search box for the specified duration, then ShareDo calls the address provider. Every call incurs some level of charge; this setting determines how often this call is made. |
| Provider |
Select Loqate. The fields that relate to Loqate display. Click to see example. Click again to close.
|
| API Key | Enter the key provided by your subscription |
| Language | Enter English. |
| Countries | Specify the countries that can be searched as a common separated list of ISO codes e.g. GBR |
Congratulations Loqate is now Installed and configured on your ShareDo environment!
AddressFinder AU
Configure ShareDo to use AddressFinder AU for Address Lookup
To perform an Address Lookup in ShareDo, you must first configure a provider. Below are the instructions for configuring Loqate as an Address Lookup provider.
AddressFinder comes preinstalled out of the box for ShareDo customers.
Configure API Key for AddressFinder
You need to provide an API Key to use the AddressFinder Service. You set this up from your AddressFinder account. If you do not have an account, register here.
- Login to your AddressFinder Account, and from the ‘Dashboard’ screen, you should click the ‘Keys’ button on the left hand navigation.
- The platform should automatically create and present to you, your first Key/Secret, but if it doesn't, or you need an alternative, you can click the orange ‘Create a New Key and Secret’ button in the top right.
- Store this Key and Secret, you will need them to configure the Address Finder in ShareDo.
Address Finder doesn't provide any specific tools to limit the API Interaction by Domain, or IP Address, however they do encourage users to rotate their keys regularly, as part of good security hygiene.
Configure the ShareDo Address Lookup for AddressFinder
Within Modeller > Global Features, navigate to Address Lookup, ensure it is enabled.
Click the Cog icon to configure the Settings.
| Setting | Description |
|---|---|
| Address Query Delay | When a user stops typing into the address search box for the specified duration then ShareDo calls the address provider. Every call incurs some level of charge; this setting determines how often this call is made. |
| Provider |
Select AddressFinder. The fields that relate to AddressFinder display. Click to see example. Click again to close.
|
| URL | https://api.addressfinder.io/api/au/ |
| API Key | Enter the key provided by your subscription |
| API Secret | Enter the secret provided by your subscription |
| Domain | Optionally enter the domain |
Congratulations Address Finder is now Installed and configured on your ShareDo environment!
Google Places
Configuring ShareDo to use Google Places for Address Lookup
Support Details
Google Places is supported as an Address Lookup provider in ShareDo from version 7.7+
The current version of Google Places Plugin is v1.0.3
To perform an Address Lookup in ShareDo, you must first configure a provider. Below are the instructions for configuring Google Places as an Address Lookup provider.
Install Google Places
To install Google Places Address Lookup in your ShareDo environment, contact your CSM and ShareDo will install it for you.
Configure the Service
You need to register an account on Google Cloud Console and create an API Key that has access to certain API Endpoints.
- Navigate to Admin > Integration > Manage Linked Services
- Add a new Linked Service, by clicking the ‘Add New’ button, in the top right hand corner.
- Select Shared Secret from the list of available service providers.
- Provide the Linked Service with an API Secret; get this from your Google Cloud Account. There are some additional account set up steps, such as configuring Google Cloud with a billing account, which are beyond the scope of this tutorial.
Some of these settings are specific to your organisation.
- In your new project select + Enable APIs and services.
- Search for ‘Places API’ in the search field
- From the results, select Places API (New). Here you can review pricing information, and other documentation.
- Select the Enable button. Next Link a Billing account. As mentioned previously.
- Once enabled, return to your project overview and go to the Keys & Credentials section.
- From here, choose ‘+ Create credentials’, and select API Key
- A modal displays your new API Key. Make sure you note this down somewhere to use later.
- Google then prompt you to Apply restrictions to the API Key. Restrictions are important to prevent your key being stolen, or misued.
It is recommended that at minimum we restrict the API Key to the following API's:
However you could go further and restrict the key to requests that originate from a specific Domain, or IP address:
- Once you are finished with the Google Cloud config, you are ready to move back into ShareDo.
- Configure the Linked service as follows;
| Field | Value |
|---|---|
| Name | Your Choice - we recommend - 'Google Places Linked Service' |
| Icon | Your Choice - we recommend - 'fa-google' |
| Description | Enter something to describe the service |
| Secret | The secret key you copied earlier on the Google Cloud Dashboard |
| Allow fallback to system secret? | On |
| API base URL | https://places.googleapis.com |
| HTTP Header to send token in | X-Goog-Api-Key |
| HTTP Header prefix | {Leave this blank} |
Configure the ShareDo Address Lookup for Google Places
Within Modeller > Global Features, navigate to Address Lookup, ensure it is enabled.
Click the Cog icon to configure the Settings.
| Setting | Description |
|---|---|
| Address Query Delay | When a user stops typing into the address search box for the specified duration then ShareDo calls the address provider. Every call incurs some level of charge; this setting determines how often this call is made. |
| Provider |
Select Google Places. The fields that relate to Google Places display. Click to see example. Click again to close.
|
| Linked Service | This dropdown provides a list of the available Linked Services in ShareDo, choose the one that you set up for Google Places. |
| Search Type |
Text Search / Auto Complete / Both For most use cases you will want to use TextSearch, or Both. |
| Regions | The Country in which you want to use Google Address Search for. |
Congratulations Google Places is now Installed and configured on your ShareDo environment!