Creating a website button for itineraries


You can publish an itinerary by creating an 'Add to TomTom' button. The button allows you to send itineraries 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 itinerary 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 if they want to install the itinerary.

This is the 'Add to TomTom' button:


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, For example, "" becomes "". There are websites and tools available that can help you do this.

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

Adding an Itinerary download button

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

<a href=""><img src="" alt="Add-To-TomTom" border="0"/></a>




action (required)

The action to be applied to the itinerary. Currently, the only action available is install.

apikey (required)

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

uri (required)

The URI pointing to the XML file that you created for your itinerary.

source (optional)

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

attribution (optional)

The name of the address supplier.

logo (optional)

A URL pointing to the logo image of the address supplier.

Click here to see a code example for an itinerary website button.