Creating access keys

Create a free demo key or a production key within your subscription to work with the 2GIS APIs.

Creating a demo key

Availability for mobile development

Demo keys are not available for working with the mobile SDK. Purchase a subscription and create a key within it.

A free demo key is created only once and is valid for one month from the date of creation. Each service has a limit of 1000 requests.

1. Sign in to the Platform Manager.
2. On the Dashboard tab, select Create a Demo Key.
3. Enter the key name and click Create.

After creating the key, you can start working with the API using examples in the documentation, such as Places API request examples.

For more information about managing keys, see the Access key management instruction. You can also view request distribution statistics.

Creating an API key

If this is your first subscription, the first API key is created automatically.

To create a key:

1. Purchase a subscription.

2. Go to the API Keys tab and click Create API Key.

3. Enter the key name and click Create.

4. If you plan to use the key for the mobile SDK:

   1. Select the Use for SDK option.

   2. (Optional) Specify the App ID for which the key will be used. Specifying the App ID is required only for SDK versions earlier than 13.3.0 or if you plan to work with offline data. App ID requirements:

      For iOS

      You can use Latin letters (A–Z, a–z), digits (0–9), dots (.) to separate segments, and hyphens (-).

      For more information, see the official documentation.

      For Android and Flutter

      • You can use Latin letters (A–Z, a–z), digits (0–9), dots (.) to separate segments, and underscores (_).
      • The App ID must contain at least two segments separated by dots (e.g., com.example.app). Each segment must start with a letter.

      For more information, see the official documentation.

      warning

      If the key has an App ID specified, you can only use this key for working with the mobile SDK. To work with the 2GIS API directly (via HTTP requests), create a separate key.

   3. Click Save and download key.

5. Go to the documentation of the product you are interested in to start working with the API.

You can use the created API key to work with all services included in the subscription.

For more information about managing keys, see the Access key management instruction. You can also view request distribution statistics.