---
metadata:
  - name: generator
    content: Diplodoc Platform v5.54.1
alternate:
  - https://yandex.ru/dev/business-api/doc/ru/quickstart.md
  - href: ru/quickstart.md
    type: text/markdown
    title: Markdown version
  - href: llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/business-api/doc/ru/llms.txt

# Начало работы с API

## Быстрый старт

### Шаг 1. Получите OAuth-токен

1. При необходимости зарегистрируйтесь в Яндекс ID. Используйте личную или корпоративную почту Яндекс.
1. Авторизуйтесь в Яндекс ID. Ваш логин будет использоваться для загрузки данных.
1. Зарегистрируйте приложение в сервисе [Яндекс OAuth](https://oauth.yandex.ru/client/new/api). Подробную  инструкцию см. в разделе [Регистрация приложения](https://yandex.ru/dev/id/doc/ru/register-client) Справки Яндекс ID.
1. Получите OAuth-токен. Подробную инструкцию см. в разделе [Получение OAuth-токена](https://yandex.ru/dev/id/doc/ru/access) Справки Яндекс ID.

### Шаг 2. Запросите доступ

Передайте токен вашему менеджеру. Доступ к API будет активирован в течение 24 рабочих часов.

### Шаг 3. Проверьте доступ

Чтобы проверить доступ, отправьте запрос на следующий URL: `https://geoadv-api.yandex.ru/priority/v1/pingping`.

Отправьте запрос `Authorization: OAuth {ваш_токен}` и ждите ответ. Если вы получили:

* `{"data": "pongpong"}` — у вас есть доступ.
* `401` — у вас нет доступа.

Если раньше вы не пользовались API Яндекс Директа, вам также требуется запросить [доступ для создания субклиентов](https://yandex.ru/dev/direct/doc/troubleshooting/add-client).

Возможные ошибки, которые встречаются при проверке:

* `Forbidden` — некорректно передается токен. Проверьте, что вы правильно выполнили инструкцию выше.
* `Unauthorized` — проблема с доступом на шаге 2. Напишите нам.

## Оплата рекламных кампаний клиентов

Для оплаты рекламных кампаний ваших клиентов на стороне Яндекса есть два варианта:

{% list tabs %}

- Субклиент

  1. Создайте «технического» субклиента в Яндекс Директе.

     {% note warning %}

     «Технический» субклиент должен использоваться только для перевода средств. На него не должно быть заведено ни одной рекламной кампании.

     {% endnote %}

  1. Пополните счет субклиента.
  1. Чтобы перевести средства нужному субклиенту вашего клиента, используйте `https://yandex.ru/priority/v1/billing-transfer`. Подробнее см. в разделе [Перевод средств](https://yandex.ru/dev/business-api/doc/ru/ref/Payment/14BillingTransferPost).

- Кредитный лимит

  Чтобы пополнить счет нужного субклиента перед запуском рекламной кампании, используйте `https://yandex.ru/priority/v1/deposit`. Подробнее см. в разделе [Депозит](https://yandex.ru/dev/business-api/doc/ru/ref/Payment/DepositPost).

{% endlist %}

## Тестирование и ограничения

{% note info %}

Ограничений на использование API нет.

{% endnote %}

Тестовая песочница отсутствует. Чтобы протестировать API, создайте рекламную кампанию для организаций без владельца:

1. Откройте [Яндекс Карты](https://yandex.ru/maps/).
1. Найдите организацию без владельца.

    {% note tip %}

    Попробуйте поискать в отдаленном от цивилизации место.

    {% endnote %}

1. Создайте для нее рекламную кампанию.
1. Для оплаты используйте субклиента — временно добавьте его во владельцы.

   {% note info %}

   Вы можете вернуть средства до 00:00 после оплаты. Чтобы запросить возврат, используйте `https://yandex.ru/priority/v1/stop-campaign` (доступ открывается по запросу).

   {% endnote %}