Access keys | Account | 2GIS Documentation
Account

Access keys

API keys give you access to the API for maps, search, and navigation: see the list of available services.

If you have not used Urbi APIs before, create a free demo key. For full operation, you can purchase access keys.

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.

To purchase a key for using APIs:

  1. Sign in to the Platform Manager.

  2. Go to the API Keys tab.

  3. Click Purchase Keys.

  4. Choose a payment period: 1 month, 6 months, or 1 year.

  5. For each service you need access to, specify the limit on the number of requests or responses (depending on the service) per month.

    If you want to use a vector 3D map, add the license for the MapGL JS API library. It allows you to add interactive and immersive maps to web applications and customize them with styles: see the list of all features on the MapGL JS API page. The license is enabled for all the keys you created.

    Services

    Before purchasing, you can try a free 2D raster map using the RasterJS API, which does not have the capabilities of the MapGL JS API.

  6. Click Proceed to API Keys.

  7. For each service, it is necessary to distribute all requests within the limits that you specified in step 5. You can allocate all requests to one key or distribute requests across multiple keys. To create a key, click Add API Key.

    For example, you set a limit of 10 000 requests per month for Places API. You can create one key with 10 000 requests or two keys with any number of requests within the limit, for example, 2800 and 7200:

    Requests

    After placing the order, you can change the limits and requests distribution only via the form.

  8. Click Proceed to Legal Data.

  9. Choose a payer: a legal entity or a sole proprietorship.

  10. Specify payment details: tax reference, RRC (for legal entities only), and email address for receiving documents.

  11. Select the checkbox to agree to the terms of the offer.

  12. Click Proceed to Payment.

  13. To generate an invoice for payment, click Order. After creating an invoice, you can change it or decline it only via the form.

  14. After the invoice is generated, check it and pay it. To see a list of invoices, click Profile icon and go to the Payment Documents section.

Important

If you pay an invoice on a non-business day, keys will be activated only on the next business day, since bank receipts are not processed on non-business days.