Skip to main content

Overview

API Platform is a set of RESTful APIs for working with data and functions available in Urbi. It allows you to integrate Urbi capabilities (maps, directory, and navigation) into your applications and services.

Installing API Platform is also required for the operation of Urbi Pro and CityLens products.

API Platform contains the following groups of services:

Statistics Collection service​

Statistics Collection service receives, processes, and stores data on the usage of API keys by map, search, and navigation services.

For more information:

Map API​

After installing API Platform, end users will be able to use the following map API:

APIDescription
MapGL JS APIAllows you to integrate an interactive 3D map, powered by WebGL, into a site or a web application.

For more information:

After installing API Platform, end users will be able to use the following search API:

APIDescription
Places APIPerforms a search for organizations, buildings and places by a wide range of criteria.
Geocoder APIDetermines coordinates of an object on the map by its address (direct geocoding) and vice versa (reverse geocoding). Also provides information about the object.
Suggest APIProvides real-time suggestions that match the search criteria while the search request is being typed.
Categories APIProvides information about categories - groups of companies that share the same business area. Also provides information about parent and child categories for given organizations. Used in conjunction with Places API.
Regions APIAllows you to select a region (an agglomeration that includes a large city and its nearest settlements). This API returns a region identifier, which can be used by other APIs to do the search for organizations, buildings, and places strictly within the region.

For more information:

After installing API Platform, end users will be able to use the following navigation API (depending on the installation configuration):

APIDescription
Routing APIBuilds car, taxi, pedestrian, bicycle, truck, and emergency services routes.
Directions APIBuilds car, bicycle, and pedestrian routes.
Truck Direction APIBuilds truck routes, taking into account the parameters of the truck and the current road restrictions.
Pairs Direction APIBuilding multiple routes in a single call.
Distance Matrix APICalculates distance and travel time between points on the map. Allows you to find points with an expected time to reach.
Map Matching APIBuilds a car route by using a set of route points recorded by a vehicle.
Isochrone APIAllows you to get an area on the map that is reachable from a given point on foot, by car, or by bicycle in a given amount of time. Can be used to display a courier delivery area based on delivery time and type of transport.
Public Transport APIBuilds routes for public transport.
TSP APIBuilds an optimal route to pass through the specified points using one or several couriers.

For more information:

Traffic API Proxy​

The Traffic API Proxy service allows fetching the real-time traffic data for other On-Premise services that demand this data. The proxy installation is optional if you do not need traffic data.

For more information:

Mobile SDK​

You can connect mobile SDK for iOS, Android, and Flutter to the installed API Platform. With the mobile SDK, you can implement the following features in your mobile application:

  • Display Urbi map and interact with it.
  • Add custom objects to the map (markers, geometric shapes, etc.).
  • Get information about map objects and search for objects in the directory.
  • Build routes for various types of transport and launch navigation.

For more information:

Platform Manager​

Platform Manager is a tool for an administrator that allows you to:

  • Check status of services operation.
  • Upload custom map styles.
  • Test in the local network the key APIs: maps, search, and navigation.

For more information: