---
metadata:
  - name: generator
    content: Diplodoc Platform v5.48.2
alternate:
  - https://yandex.ru/dev/developer-help/doc/en/quickstart.md
  - https://yandex.ru/dev/developer-help/doc/ru/quickstart.md
  - https://yandex.ru/dev/developer-help/doc/tr/quickstart.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/developer-help/doc/en/llms.txt

### Quick start

## **Step 1. Log in** {#auth}

{% note info "**Note**" %}

Don't use personal logins; create a separate login for working with the Yandex Maps API — you won't be able to transfer keys and products from your login to another one.

{% endnote %}

Open the Yandex Maps API [dashboard](https://developer.tech.yandex.ru/?modern=true) and log in with your Yandex ID. If you don't have a login yet, [register](https://passport.yandex.ru/registration?mode=register).

{% note info "**Note**" %}

When you first enter the Dashboard, in the dialog box select the country where you are a tax resident and from which you will pay for API products. After you confirm your choice, you won't be able to change the country.

{% endnote %}

## **Step 2. Select an API product** {#create}

If you don't have any connected APIs:

1. {% cut "On the main page, hover the cursor over a product card and click the pop-up **Connect** button." %}

    ![](_assets/api-connect-first-time.png)

    {% endcut %}

If you already have connected APIs:

1. On the main page, click the **Connect API** button.
2. {% cut "In the window that opens, hover the cursor over a product card and click it." %}

    ![](_assets/api-connect.png)

    {% endcut %}

    1. {% cut "If you need to connect a product that isn't related to the Yandex Maps API, hover the cursor over the **More** button and click it" %}

        ![](_assets/api-other-connect.png)

        {% endcut %}

    2. Hover the cursor over a product card and click it.

3. {% cut "Click the **Connect API** button." %}

    ![](_assets/api-connect-btn.png)

    {% endcut %}

## **Step 3. Select a plan** {#create}

On the **Plans** page that opens:

1. Click the product's **Usage parameters** radio button.
    1. Configure the paid plan usage parameters\*:
        1. {% cut "Select the validity period of the paid plan - the payment period: 1 year or 1 month." %}

            ![](_assets/tariff-choose-period.png)

            {% endcut %}

        2. {% cut "Select the plan start date." %}

            ![](_assets/tariff-choose-date.png)

            {% endcut %}

        3. {% cut "Set the slider to the required daily request limit." %}

            ![](_assets/tariff-choose-limit.png)

            {% endcut %}

        4. {% cut "Specify whether an extended license is required to store results during the validity period of the paid plan." %}

            ![](_assets/tariff-choose-saving.png)

            {% endcut %}

    2. {% cut "Read the terms of the [Offer](https://yandex.ru/legal/maps_api_offer/ru/) and select the checkbox." %}

        ![](_assets/tariff-accept-conditions.png)

        {% endcut %}

    3. {% cut "Click the **Connect.** button" %}

        ![](_assets/tariff-connect.png)

        {% endcut %}

## **Step 4. Pay the plan cost** {#create}

On the **Plans** - **Plan Payment** page that opens, you need to select a payer and issue an invoice for the plan cost. If you already have payers, select one from the list. If you are paying for the first time, add a new one:

1.  {% cut "Select the payer type — a legal entity or an individual." %}

    ![](_assets/payer-type.png)

    {% endcut %}

2.  Fill in the payer details:
    1. Legal entity - TIN, organization name, full organization name with the form of ownership, phone number, email address, legal address, postal address, postal code.
    2. Individual - last name, first name, middle name, phone number, email address.

3.  {% cut "The payment amount is automatically set equal to the plan cost. " %}

    ![](_assets/payment-sum.png)

    {% endcut %}

4.  {% cut "Click the **Issue invoice** button." %}

    ![](_assets/payment-btn.png)

    {% endcut %}
    1. A [page](https://balance.yandex.ru/) of the Yandex Balance personal account will automatically open in a new browser tab, where you can download the generated invoice to pay for the plan by bank transfer, card, etc.

    2. {% cut "Check the selected payer." %}

        ![](_assets/balance-payer.png)

        {% endcut %}

    3. {% cut "Select a payment method." %}

        ![](_assets/balance-payment-type.png)

        {% endcut %}

    4. {% cut "Click the **Issue invoice** *for the amount* button." %}

        ![](_assets/balance-invoice-btn.png)

        {% endcut %}

    5. {% cut "The invoice has been issued — you can download it or send it by email." %}

        ![](_assets/balance-invoice.png)

        {% endcut %}

5.  {% cut "Return to the Yandex Maps API dashboard in the browser tab with the **Plans** - **Plan Payment** page and, to continue, click the **Go to product** button." %}

    ![](_assets/go-to-product.png)

    {% endcut %}

6.  {% cut "The product page contains the **Plan**, **Payer**, **Keys**, and **Statistics** sections." %}

    ![](_assets/service-page.png)

    {% endcut %}

{% note info "**Note**" %}

The time it takes for funds to arrive depends on the bank and on the chosen payment method; as a rule, card payments arrive faster, followed by a bank transfer, and the slowest is a transfer using a QR code.

After the funds arrive in the payer's personal account in Yandex Balance, the paid plan is activated on the selected plan start date.

{% endnote %}

## **Step 5. Set up the API key (for the JavaScript API)** {#create}

{% note info "**Note**" %}

JavaScript API 3.0 works only with keys that have the "HTTP Referer restriction" field filled in. [More about restrictions](https://yandex.ru/maps-api/docs/js-api/limit.html)

{% endnote %}

An **API key** is a unique identifier that provides access to one or more Yandex Maps API products. The first key is created automatically when you connect API products. For paid plans, the key becomes active on the selected plan start date. If needed, you can create new keys yourself by going to the **Keys** section of the main menu.

To set up the key on the JavaScript API product page, in the **Keys** section:

1. {% cut "Find the key created automatically when the JavaScript API product was connected. The key status is **Not configured**." %}

    ![](_assets/find-key.png)

    {% endcut %}

2. {% cut "On the right, in the row with the key data, click ![](_assets/dots.png =32x15) and then **Set up**." %}

    ![](_assets/key-settings.png)

    {% endcut %}

3. {% cut "Configure the key restrictions - the **HTTP referer restriction**." %}

    ![](_assets/key-jsapi-referrer.png)

    {% endcut %}

4. Click the **Save** button.

5. {% cut "Make sure the key status has changed to **Active**." %}

    ![](_assets/key-active.png)

    {% endcut %}

{% note info "**Note**" %}

To block the key-product link, select the key, click ![](\_assets/dots.png =32x15) and **Unlink product**; the key-product link status will change to "Inactive".

{% endnote %}

## **Next steps** {#create}

In the Dashboard, you can also:

- Add new keys, link/unlink keys to Yandex Maps API products, and change a key's name

- View and download statistics for individual keys and products

- Top up the personal account and switch between payers

- Follow the links in the Yandex Balance personal account to change payer details and review acts and documents

A free plan is also available for some products.