API Platform

To work with the API, you need to get an access key:

1. Sign in to the Platform Manager.
2. Create a demo key or purchase a subscription to use the APIs.
3. Study the examples of requests and responses in the documentation for the required API.

• Unlimited access to the MapGL JS API is included in the cost of using the Map Tiles API, which is used to obtain vector tiles.
• Unlimited access to the RasterJS API is included in the cost of using the Raster Tiles API, which is used to obtain raster tiles.
• The cost of using Map Tiles API, Raster Tiles API, and Static API is calculated based on the number of API requests. For more details on the calculation method, see the Tariffs section on each API page.
• The Style Editor and FloorsJS are provided free of charge.

You can get a demo access key to test map APIs for one month with a limited number of requests.

You can track the progress of limit consumption by services and request distribution statistics in the Platform Manager. For more details, see the Statistics section.

To avoid premature exhaustion of limits, you can restrict the use of API resources by your applications. In the Platform Manager personal account, several ways to configure restrictions are available:

• Set limits on requests to specific services for all API keys in the subscription or for individual keys. Exceeding the limits will block product usage: API requests will return an error.
• Configure notifications to be sent when approaching limits.

For more details, see the Access key management section.

A tile is a square image corresponding to a section of the map. Using tiles helps save device resources and display only the visible part of the map, loading the necessary fragments when moving across the map or changing the map scale.

Raster tiles are images of map fragments in PNG format, which are rendered on the server side and sent to your device in a ready-made form. Displaying a raster map requires fewer device resources but does not allow you to customize the map appearance and behavior flexibly. To work with a raster map, use the Raster Tiles API or Static API.

Vector tiles are data that your device receives and renders independently, according to the specified style (rendering rule). Vector tiles allow you to change the appearance of the map in real time, create interactive objects and animations, and provide smoother scaling and movement across the map. To work with a vector map, use the MapGL JS API library.

• Vector tiles: to access the Map Tiles API, you can use only the MapGL JS API library.
• Raster tiles: it is recommended to use the RasterJS API library. You can also use third-party libraries, but their compatibility with Urbi raster maps is not guaranteed and may be disrupted at any time without notice.

For more details, see the Services Use Agreement.

If you need to obtain vector tiles directly for integrating them into a GIS system that does not support the use of the MapGL JS API, you can install the Urbi API Platform in a private environment (On-Premise) and export vector tiles in the Mapbox Vector Tiles (MVT) format. Raster tiles can be obtained directly through the Raster Tiles API and Static API.

The MapGL JS API is optimized for use in modern web browsers; see the complete list of supported browsers and their versions in the Browser support section. If you plan to add 3D objects to the map, review the Requirements and recommendations for 3D models.

When working with Urbi vector maps through the MapGL JS API, you can:

• Configure the map center, zoom level, map controls, graphic mode, event handling, etc.
• Change the appearance of the map (colors, lighting, level of detail, visibility of objects and labels, and much more) using the Style Editor.
• Add your own data to the map: objects of varying complexity (icons, animated markers, 3D models) or sources of vector and raster geodata.

When working with Urbi raster maps through the Raster Tiles API and Static API, you can:

• Configure the map center, zoom level, map controls, event handling, etc.
• Add your own data to the map: objects (markers, geometric shapes, labels) or geodata in GeoJSON format.

Yes, you can install the Urbi API Platform in a closed environment. For more information, see the On-Premise section.

Use the documentation search or send an email to api@2gis.ru.