Sorry, you need to enable JavaScript to visit this website.

Migrate from previous versions - the Services library

Overview of the tutorial

This tutorial covers basic use cases to help you switch our services. For example, switching the Routing API or Search API services from our previous versions of the Maps SDK for Web to our new version. We will use code examples to explain the main differences between the SDKs. In the new SDK, services are not part of the map library. We now provide a separate library to only include services.

You can check how to migrate map displaying here: Migrate from previous versions - the Maps library

To start using the latest version of TomTom Maps SDK for Web you need the following:

  • The Services library
    The Maps SDK for Web can be used in three ways:
    • Downloaded from NPM: https://www.npmjs.com/package/@tomtom-international/web-sdk-services
    • With a CDN: https://api.tomtom.com/maps-sdk-for-web/cdn/5.x/<version>/services/services-web.min.js - NOTE: include the latest version in the URL.
    • Downloaded from here: Downloads.

    In this tutorial, we are using CDN as an example.

  • API Key
    Get your API Key now

    To create a new API Key you need to first register on the portal. Once you are logged in there is only one step remaining:

    Go to your Dashboard:

    My dashboard

    You can now click on your app - My first app and copy your API Key:

    My API Key
  • Add the following to the <head> element of your HTML document:

                    <!-- Replace version in the URL with desired library version -->
                    <script src='https://api.tomtom.com/maps-sdk-for-web/cdn/5.x/<version>/services/services-web.min.js'></script>
                    

    Maps and services use the same namespace and will automatically attach themselves to the tt object. Services will be accessible using tt.services.

 

Displaying a route/directions

Here we have the code to display a route from point A to point B on the map.

Previous versions of the Maps SDK for Web

    tomtom.routing()
        .key('<your-api-key>')
        .locations('37.7683909618184,-122.51089453697205:37.769167,-122.478468')
        .go().then(function(routeJson) {
            var route = tomtom.L.geoJson(routeJson, {
                style: {color: '#00d7ff', opacity: 0.6, weight: 6}
            }).addTo(map);
            map.fitBounds(route.getBounds(), {padding: [5, 5]});
        });
    

Latest version of the Maps SDK for Web

    tt.services.calculateRoute({
          key: '<your-api-key>',
          locations: '-122.510601,37.768014:-122.478468,37.769167'
        })
        .go()
        .then(function(response) {
            var geojson = response.toGeoJson();
            map.addLayer({
                'id': 'route',
                'type': 'line',
                'source': {
                    'type': 'geojson',
                    'data': geojson
                },
                'paint': {
                    'line-color': '#00d7ff',
                    'line-width': 8
                }
            });
            var bounds = new tt.LngLatBounds();
            geojson.features[0].geometry.coordinates.forEach(function(point) {
                bounds.extend(tt.LngLat.convert(point));
            });
            map.fitBounds(bounds, {padding: 20});
        });
    

Differences in APIs

Here is an overview of some of the most important updates within our top-level namespace.

Common factory functions renamed

Some of the common functions changed. Here are some examples:

Previous versions Current version
tomtom.key(key, [value]) You need to pass the API Key directly to the service.
            tt.services.fuzzySearch({key: API-KEY, ...});
tomtom.localeService() You need to pass the language directly to the service. For the map, you can also change the language after initialization by doing:
            map.setLanguage('en');

The following table lists the services from the previous SDK and their equivalent in the latest one.

Previous versions Current version
tomtom.alongRouteSearch() tt.services.alongRouteSearch()
tomtom.reachableRange() tt.services.calculateReachableRange()
tomtom.routing() tt.services.calculateRoute()
tomtom.categorySearch() tt.services.categorySearch()
tomtom.copyright() tt.services.copyrights()
tomtom.copyrightCaption() tt.services.copyrightsCaption()
tomtom.crossStreetLookup() tt.services.crossStreetLookup()
tomtom.fuzzySearch() tt.services.fuzzySearch()
tomtom.geocode() tt.services.geocode()
tomtom.geometrySearch() tt.services.geometrySearch()
No equivalent tt.services.incidentViewport()
tomtom.matrixRouting() tt.services.matrixRouting()
tomtom.nearbySearch() tt.services.nearbySearch()
tomtom.poiSearch() tt.services.poiSearch()
tomtom.reverseGeocode() tt.services.reverseGeocode()
tomtom.staticMapImage() tt.services.staticImage()
tomtom.structuredGeocode() tt.services.structuredGeocode()
tomtom.traffic() tt.services.incidentDetails()
tomtom.trafficFlowSegmentData() tt.services.trafficFlowSegmentData()