Maps API | On-Premise | 2GIS Documentation

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.

On-premise Maps services architecture

Maps can be deployed in two different configurations:

  • MapGL JS API + Vector Tiles API

    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.

    Additional features:

    • To get real-time traffic data from Traffic Servers, configure the Traffic API Proxy service. End users and applications can then use MapGL JS API to plot colored traffic status on a map's overlay.
    • To display 3D floor plans of buildings on the map, install the Floors API service so that MapGL JS API can get floors data and render it.
  • Raster Tiles API

    This configuration is designed to be used primarily with the GIS Platform service that consumes the raster tiles.

Each deployment configuration requires the Tiles API service that 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, an application consumes less memory when working with the map.

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

  • For configuration with MapGL JS API and Vector Tiles API

    • Apache Cassandra data storage for storing tiles.
    • Traffic API Proxy configured to provide the traffic data in vector format.
    • Floors API service.
  • For configuration with Raster Tiles API

    • License service.
    • API Keys service.
    • Apache Cassandra data storage for storing tiles.

Detailed requirements for each service are listed in the System requirements document.

What's next?