Access keys
If you plan to work with Urbi map, navigation, and search APIs, you need an access key. Platform Manager allows you to create and manage access keys.
In the Platform Manager, you can:
- Create a free demo key for using APIs: see the Access keys instruction.
- View the list of created keys, available APIs, the limits set for them, and the lock date of the keys.
- Check the statistics of request distribution for each key and service for any period: see the Statistics instruction.
- Set restrictions for a key by HTTP headers, IP addresses, subnets, and applications.
- Learn how different API settings work by using some services in the sandbox.
Services
Maps
API |
Description |
---|---|
MapGL JS API | JavaScript library. Allows to integrate an interactive Urbi 3D map, powered by WebGL, into a site or a web application. |
Search
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. Used in conjunction with Places API. |
Regions API | Allows to select a region (an agglomeration that includes a large city and its nearest settlements). Returns a region identifier, which can be used by other APIs to perform a search for organizations, buildings, and places strictly within the region. |
Markers API | Performs a search for organizations, buildings, and places to display markers on the map. |
Navigation
API |
Description |
---|---|
Routing API | Builds car, taxi, pedestrian, bicycle, truck, and emergency services routes. |
Public Transport API | Builds routes for public transport. |
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. |
Creating a demo key
The demo key is created only once and is valid for one month from the creation date. There is a limit of 1000 requests per service.
To create a demo key:
- Sign in to the Platform Manager.
- Go to the API Keys tab.
- Click Free Demo Key.
- Enter a key name.
- Click Create.
After you create a demo key, you can use the examples in the documentation to get started working with the APIs, e.g., examples of the Places API requests.
Purchasing a key
To purchase a key for using APIs, contact the manager.