Solution overview
API Platform for server is a set of services that allow you to work with 2GIS data in your infrastructure and manage API keys and license.
Key features:
- services run in a private network without internet access - only a few utility services require an internet connection
- ability to independently issue and revoke API keys for controlling access to products
- horizontal and vertical scaling
Services run in a Kubernetes cluster: they are updated via Helm with no manual dependency configuration and run in multiple replicas to ensure fault tolerance, while Ingress balances incoming requests. Multi-level caching reduces request processing time.
Components of the API Platform for server include core services and the API Platform. Installing them is also required for the operation of 2GIS Pro and 2GIS CityLens.
Core services
Core services are required for the operation of any other components of the On-Premise software suite. They must be installed before installing other components.
License service
The License service is responsible for obtaining and verifying the license for using the installed services.
See more:
API Keys service
The API Keys service is responsible for managing end-user access to the installed services.
See more:
API Platform
API Platform is a set of RESTful APIs for working with data and functions available in 2GIS. It allows you to integrate 2GIS capabilities (maps, directory, and navigation) into your applications and services.
Statistics Collection service
Statistics Collection service receives, processes, and stores data on the usage of API keys by map, search, and navigation services. This is an optional service: to get statistics on API key usage, install it before installing the services below.
For more information:
- Architecture of the Statistics Collection service
- Installing the Statistics Collection service
- Updating the Statistics Collection service
Map API
After installing API Platform, end users will be able to use the following map API:
| API | Description |
|---|---|
| MapGL JS API | Allows you to integrate an interactive 3D map, powered by WebGL, into a site or a web application. |
For more information:
Search API
After installing API Platform, end users will be able to use the following search API:
| API | Description |
|---|---|
| Places API | Performs a search for organizations, buildings and places by a wide range of criteria. |
| Geocoder API | Determines coordinates of an object on the map by its address (direct geocoding) and vice versa (reverse geocoding). Also provides information about the object. |
| Suggest API | Provides real-time suggestions that match the search criteria while the search request is being typed. |
| Categories API | Provides 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 API | Allows 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:
Navigation API
After installing API Platform, end users will be able to use the following navigation API (depending on the installation configuration):
| API | Description |
|---|---|
| Routing API | Builds car, taxi, bicycle, scooter, motorcycle, truck, emergency services, pedestrian, and public transport routes. |
| Directions API | Builds car, taxi, bicycle, scooter, motorcycle, truck, and pedestrian routes. |
| Truck Directions API | Builds truck routes, taking into account the parameters of the truck and the current road restrictions. |
| Pairs Directions API | Building multiple routes in a single request. |
| Distance Matrix API | Calculates distance and travel time between points on the map. Allows to find points with an expected time to reach. |
| TSP API | Solves the traveling salesman problem: builds the shortest route in time or distance to pass through the specified points. |
| Isochrone API | Allows to get an area on the map that is reachable from a given point in a given amount of time by car, by bicycle, or on foot. Can be used to display a courier delivery area based on delivery time and type of transport. |
| Map Matching API | Builds a car route by using a set of route points recorded by a vehicle. |
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
With the mobile SDK, you can implement the following features in your mobile application:
- display 2GIS 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
You can connect mobile SDK for iOS, Android, and Flutter to the installed API Platform.
The mobile SDK for iOS, Android, and Flutter only up to and including version 12.10 is available for use in a private network.
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.
- View the statistics on requests to services.
For more information: