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. Getting certain information about objects is only available for an extra cost (see details below).
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. Getting certain information about objects is only available for an extra cost (see details below).
Suggest API	Provides real-time suggestions that match the search criteria while the search request is being typed. Getting certain information about objects is only available for an extra cost (see details below).
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.

Part of information about objects is only available on demand and for an extra cost. To purchase access to the methods and fields below, contact the Urbi sales team.

• Places API methods:

  • /3.0/items/bysite - searching for organizations by a website address
  • /3.0/items/byphone - searching for organizations by a phone number
  • /3.0/items/byitin - searching for organizations by an individual tax identification number
  • /3.0/items/bytradelicense - searching for organizations by a trade license number
  • /3.0/items/byfias - searching for organizations by a code in the Federal Information Address System

• Places API, Geocoder API, and Suggest API fields (specified in the fields parameter):

  • items.contact_groups - detailed contact information of the organization
  • items.floors - number of floors
  • items.floor_plans - floor plans
  • items.links.database_entrances.apartments_info - information about apartments in the building
  • items.employees_org_count - number of employees of the organization
  • items.itin - individual tax identification number
  • items.trade_license - trade license
  • items.fias_code - code of streets or administrative territories in the Federal Information Address System
  • items.address.components.fias_code - code of buildings in the Federal Information Address System
  • items.fns_code - Federal Tax Service code of administrative territories
  • items.okato - code of streets and administrative territories in the National Classifier of Administrative Territorial Entities
  • items.address.components.okato - code of buildings in the National Classifier of Administrative Territorial Entities
  • items.oktmo - code of streets and administrative territories in the National Classification of Territories of Municipal Formations
  • items.address.components.oktmo - code of buildings in the National Classification of Territories of Municipal Formations
  • items.structure_info.material - information about the building material
  • items.structure_info.apartments_count - number of apartments in the building
  • items.structure_info.porch_count - number of entrances in the building
  • items.structure_info.floor_type - floor type in the building
  • items.structure_info.gas_type - type of gas supply in the building
  • items.structure_info.year_of_construction - year of building construction
  • items.structure_info.elevators_count - number of elevators in the building
  • items.structure_info.is_in_emergency_state - whether the building is considered to be in emergency state
  • items.structure_info.project_type - series or a project of building construction
  • items.structure_info.chs_name - name of the cultural heritage site
  • items.structure_info.chs_category - category of the cultural heritage site

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:

1. Sign in to the Platform Manager.
2. Go to the API Keys tab.
3. Click Free Demo Key.
4. Enter a key name.
5. 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.