Maps API | On‑Premise | Urbi Documentation
On‑Premise
Maps
Search
Navigation
Urbi Pro
CityLens
On‑Premise
Account

Maps services

Maps services allow displaying maps in web applications and websites.

This article describes how to deploy and configure the Maps services in your environment. To learn how to use the JavaScript library provided by the Maps services, see MapGL JS API Overview.

Architecture

On-premise Maps services architecture

NGINX Web Server

Provides static files (font, icons) to MapGL JS API – in fact, to websites and web applications. To use the API, it is necessary to download the main library file (api.js) and the default (light) style for the map (the style directory) from the web server.

Floors API

Provides 3D floor plans of buildings on the map to MapGL JS API

Note

Mobile applications (Android and iOS) use Catalog API instead to obtain 3D floor plans of buildings

Traffic API Proxy

Provides real-time traffic data from Traffic Servers. End users and applications can then use MapGL JS API or Mobile SDK to plot colored traffic status on a map's overlay.

Tiles API

Provides an API to access and display map tiles. A tile is a square image of a part of the map (example tiled map). With tiles it is possible to render only visible part of map, fetching the necessary tiles when the map is either zoomed or moved. Therefore, memory consumption is reduced when working with the map.

For detailed overview of the On-Premise solution architecture, see Solution architecture.

Tiles that Tiles API provides:

Tile type Consumers
Vector MapGL JS API, Mobile SDK
Mobile Mobile SDK
Raster MapGL JS API, Mobile SDK, GIS Platform

Styles API

Provides an API to conveniently apply customized map styles. You can create a personalized style using the Style editor, upload it to the On-Premise environment using the Platform Manager interface, and connect it to your map in the MapGL JS API settings.

If Styles API is not installed, the default style is applied to the map.

License service

Provides a license to access the map services. For more information, see the License service architecture.

API Keys service

Provides an API key to access the map services. For more information, see the API Keys service architecture.

Dependencies

Dependencies, mandatory for all configurations:

  • License service.
  • API Keys service.
  • Apache Cassandra data storage for storing tiles. Configurations with MapGL JS API and Mobile SDK use different tilesets.

Optional dependencies, the inclusion of which depends on the selected configuration

  • Traffic API Proxy configured to provide the traffic data in vector format. Configurations with MapGL JS API and Mobile SDK use separate instances.
  • NGINX Web Server to display styles and icons.
  • Floors API service to display floor plans.
  • Styles API service to load custom styles created in the Style editor. This service requires configuration of PostgreSQL and an S3 compatible storage.

For more information on how to check requirements for each service, refer to the System requirements document.

What's next?