Publishing geo-references

Print 

You can publish a geo-reference by creating an 'Add to TomTom' button. The button allows you to send geo-references to your users' TomTom devices via TomTom HOME. When the button is clicked, the user is redirected to the addto.tomtom website which checks if TomTom HOME is installed. If yes, the geo-reference is sent to TomTom HOME. If HOME is not installed, the user is asked to install it. HOME receives the information and asks the user what they want to do with it, for example, show a location on the map, navigate to a location or add it to their Favourites.

This is the 'Add to TomTom' button:

add-to-my-tomtom  

Follow the instructions below to place an 'Add to TomTom' button on your website.

Note: All non-alphanumeric characters in the URL parameters of the HTML button code (see below) must be URL-escaped. This means that you need to replace all non-alphanumeric characters with the hexadecimal encoding for the value of that character. For example, "Den Haag" becomes "Den%20Haag", "København" becomes "K%C3%B8benhavn". There are websites and tools available that can help you do this.

 

Adding a Geo-Reference button

To add a button to your website, copy and paste the code below onto your web page and adapt the parameters accordingly. The image for the button is downloaded from a TomTom server.

<a href="http://addto.tomtom.com/api/home/v2/georeference?action=add&amp;apikey=yourAPIKey&amp;name=TomTom&amp;latitude=51.4989&amp;longitude=-0.1786&amp;source=http%3A//www.YourDomain.com"><img src="http://addto.tomtom.com/api/images/addtotomtom-button.gif" alt="Add-To-TomTom" border="0"/></a>

Parameter

Description

action (required)

The action to be applied to the geo-reference. Currently, the only action available is add.

apikey (required)

A valid API key is required to use the 'Add to TomTom' buttons. You can get an API key by emailing add2TTsupport@tomtom.com

name (optional)

The name that represents the location, for example "Rijksmuseum".

latitude (required)

Geographic latitude of the location in decimal degrees. May be negative; "N"/"S"/"W"/"E" suffix is not accepted. Default geodetic datum is WGS-84.

longitude (required)

Geographic longitude of the location in decimal degrees. May be negative; "N"/"S"/"W"/"E" suffix is not accepted. Default geodetic datum is WGS-84.

attribution (optional)

The name of the geo-reference supplier.

logo (optional)

A URL pointing to the logo image of the geo-reference supplier.

source (optional)

The URL pointing the original page where the button is placed. This is used to go back to the page when the installation of the content is finished.

Click here to see code examples for 'Add to TomTom' address buttons.

Next step: Once you have added the button to your website and tested it, you've finished!