Working with the Platform Manager

Differences between On-Cloud and On-Premise versions

The Platform Manager is available both On-Cloud (see more in the account documentation) and On-Premise. The available features differ depending on the installation:

	On-Cloud	On-Premise
Monitoring services	✗	✓
Uploading custom map styles	✗ (You can specify the style in map settings)	✓
Testing services in the sandbox	✓	✓
Creating access keys	✓	✗ (Only in the API keys management web interface)
Managing access keys	✓	✗ (Only in the API keys management web interface)
Viewing statistics on access keys	✓	✓
Managing users and roles	✓ (See the User management) instruction	✓

Getting started

To start working with the Platform Manager, follow the steps below:

1. Make sure the Platform Manager service is installed and works properly. For details, see the Installing the Platform Manager instruction.
2. Go to a URL in the https://platform.example.com format that you received after installing the service.

The Platform Manager interface contains three tabs:

• Status Page

  

  Here you can:

  • View the list of services installed within the On-Premise complex.
  • Check their status.

• Map Styles

  

  Here you can:

  • Upload custom map styles to use in a private environment.
  • Update map styles and switch between them. You can use new styles or upload updated versions of the same style.
  • View the list of uploaded styles along with their details: style ID, version, and the map type they are created for.
  • Delete uploaded styles.

• Playgrounds

  

  Here you can test the operation of key APIs (you do not need to install services to work with playgrounds):

  • MapGL JS API: a 3D interactive map based on the WebGL engine.
  • Geocoder API: a search API for determining the coordinates of an object by address (direct geocoding) and vice versa (reverse geocoding).
  • Directions API: a navigation API for building car, bicycle, and pedestrian routes.

  Example of working in the playground:

  

Managing map styles

Uploading and applying a map style

You can create a unique map style and use it in your environment.

1. Make sure that the Styles API is installed along with other map services.

2. Open the Style editor and create a map style.

   See instructions on creating and configuring styles in the Style editor documentation.

3. Export the created style from the Style editor:

   1. In the Style editor, open the card of the required style in the My styles block.

   2. In the top menu, click Share, and then click Export the style in the opened dialog.

      

   3. Select the required style from the list and click Export.

      A new panel appears, preparing the archive for download.

   4. When the style is in the Done status, select it from the list and click Download the style.

   5. Save the generated .tar.gz archive locally.

4. Upload the style to the On-Premise environment:

   1. Open the Platform Manager in a browser.
   2. Go to the Map Styles tab and click Upload Style.
   3. Add the exported .tar.gz archive and wait until it is successfully uploaded (the archive status must be Uploaded).

5. To check how the uploaded style looks in the sandbox, on the Map Styles tab, click the required style name.

6. Copy the generated style ID from the Map Style ID field and apply it to the map using the MapGL JS API.

You can upload different versions of one style and switch between them in the Platform Manager: for more details, see the Updating a map style section.

Updating a map style

You can apply a new style to the map or update a previously created one.

1. Open the Style editor and create a new style or edit an existing one.

   See instructions on creating and configuring styles in the Style editor documentation.

2. Follow the steps to export the style from the Style editor and upload it to the Platform Manager.

3. If you upload an updated version of the existing style, its ID does not change. The Platform Manager detects the update as a new version of the style. You can switch between versions of one style.

4. If you upload a new style, copy the generated style ID from the Map Style ID field and apply it to the map using the MapGL JS API.

Deleting a map style

Important

Before deleting a style, make sure it is not applied to any active map. Otherwise, the map may display incorrectly when the style is removed.

1. Open the Platform Manager in a browser.
2. Go to the Map Styles tab and click icon next to the required style.

Viewing statistics

On the Statistics tab, you can view detailed data on the number of requests. You can filter the data by time period, service, and API key. Example of statistics display:

The graph displays the number of requests to services for each day of the selected period.

Note

Data on all graphs is updated after a delay of several minutes.

Request distribution statistics

To view the statistics of request distribution:

1. Go to the Statistics tab.

2. Select the period for which you need to get the statistics (today, the last week, month, or year) or specify a custom period of time in the Period field. Date and time are specified in UTC format.

3. In the Key field, select the access keys for which you need to get the statistics. To select all keys, select Select all.

   To filter keys by status and usage mode, click icon, select the key status (Active, Inactive) and mode (Demo for a demo key and Prod for the main key).

4. In the Service field, select the services for which you need to get the statistics. To select all services, select Select all.

Downloading a file with the statistics

You can download the statistics as a file with a table in .xlsx format. The table contains the following fields:

• Key: key ID.
• Date: request date.
• Service: service to which a request is sent.
• Mode: key usage mode (demo for a demo key or prod for a main key).
• Method: endpoint to which a request is sent.
• Result: request result (Success, Empty response, or Error).
• Result code: code of a request result.
• Requests amount: number of requests during a day specified on a date.
• Organizations: number of organizations that are received via the Places API, the Suggest API, and the Markers API.
• Geo objects: number of geo objects that are received via the Search APIs.
• Routes: number of routes that are built via the Navigation APIs, excluding the Isochrone API.

To download a file containing the statistics of request distribution:

1. Go to the Statistics tab.
2. Select a period, keys, and service.
3. Click Download in XLSX.