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

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

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

  1. При необходимости зарегистрируйтесь в Яндекс ID. Используйте личную или корпоративную почту Яндекс.
  2. Авторизуйтесь в Яндекс ID. Ваш логин будет использоваться для загрузки данных.
  3. Зарегистрируйте приложение в сервисе Яндекс OAuth. Подробную инструкцию см. в разделе Регистрация приложения Справки Яндекс ID.
  4. Получите OAuth-токен. Подробную инструкцию см. в разделе Получение OAuth-токена Справки Яндекс ID.

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

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

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

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

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

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

Если раньше вы не пользовались API Яндекс Директа, вам также требуется запросить доступ для создание субклиентов.

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

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

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

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

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

    Важно

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

  2. Пополните счет субклиента.

  3. Чтобы перевести средства нужному субклиенту вашего клиента, используйте https://yandex.ru/priority/v1/billing-transfer. Подробнее см. в разделе Перевод средств Справки API Бизнеса.

Чтобы пополнить счет нужного субклиента перед запуском рекламной кампании, используйте https://yandex.ru/priority/v1/deposit. Подробнее см. в разделе Депозит Справки API Бизнеса.

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

Примечание

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

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

  1. Откройте Яндекс Карты.

  2. Найдите организацию без владельца.

    Совет

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

  3. Создайте для нее рекламную кампанию.

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

    Примечание

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

Предыдущая
Введение
Следующая
Overview