Skip to main content

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

MapGL JS API service​

Provides MapGL JS API library files for use on websites and in web applications.

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 - square images of parts of the map (example of a tiled map). With tiles, you can render only the visible part of the map and fetch the necessary tiles when the map is moved or its zoom level is changed. This helps reduce memory consumption when working with the map.

Tiles that Tiles API provides:

Tile typeConsumers
VectorMapGL JS API, Mobile SDK
MobileMobile SDK
RasterMapGL JS API, Static API, Mobile SDK

For more information about the On-Premise software suite architecture, see Software suite architecture.

Tilegen API​

Provides an API to generate vector tiles from user data.

Static API​

Provides an API for generating static map images in PNG format. The service fetches raster tiles from Tiles API, generates an image of the specified area at the given zoom level, and overlays information passed in the request - areas, lines, markers, and other objects.

Styles API​

Provides an API for applying custom 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. For more information, see the Uploading and applying a map style instruction.

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.

Statistics Collection service​

Collects statistics on the usage of API keys to access the maps services. For more information, see the Statistics Collection 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.
Software alternatives

Instead of Apache Cassandra, you can use an alternative included in the unified register of Russian programs. For the list of alternatives, see the System requirements section.

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.
  • Styles API service to load custom styles created in the Style editor. The service requires configuration of PostgreSQL and an S3 compatible storage.
  • Tilegen API service to generate vector tiles from user data. This service requires configuration of Redis.

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

What's next?​