API Яндекс Директа: доступ, авторизация, формат запросов
API Директа даёт программный доступ к данным и те же операции с рекламными материалами, что веб-интерфейс. Подключение и использование бесплатны. Запросы идут по HTTPS методом POST, в теле — JSON или SOAP/XML, авторизация по OAuth 2.0. Чтобы управлять своими кампаниями, нужно принять условия на странице API; разработчику ещё регистрируют приложение в сервисе API Яндекс ID и подают заявку на доступ.
Цифры
| Параметр | Значение |
|---|---|
| Стоимость | бесплатно |
| Авторизация | OAuth 2.0, в запросе указывается токен |
| Протокол | HTTPS |
| Метод | POST |
| Формат тела запроса и ответа | JSON или SOAP/XML |
| Куда идут токен и спецпараметры | HTTP-заголовки |
| Версия, описанная в справке | 5 |
| Условие для работы со своими кампаниями | принять условия пользовательского соглашения на странице API сервиса Яндекс Директ |
| Условие для разработчика | зарегистрировать приложение в сервисе API Яндекс ID и подать заявку на доступ |
Подробности
Для кого и зачем
Справка называет API полезным прежде всего агентствам и крупным заказчикам, например торговым порталам со сложными и масштабными кампаниями. Собственные приложения позволяют применять свои алгоритмы назначения ставок и вовремя получать статистику.
Примеры использования из справки:
- останавливать и возобновлять показы в зависимости от наличия товара на складе;
- автоматически генерировать ключевые фразы, добавляя названия товаров;
- выгружать статистику показов, кликов, конверсий и расходов в системы финансового учёта и поддержки принятия решений.
Доступ и авторизация
Запросы выполняет приложение от имени пользователей Директа: рекламодателей и рекламных агентств. В запросах указывается авторизационный токен, который разрешает приложению доступ к данным конкретного пользователя.
- Для управления своими кампаниями через API принимают условия пользовательского соглашения на странице API сервиса Яндекс Директ.
- Разработчики регистрируют приложение в сервисе API Яндекс ID и подают заявку на доступ к API.
Формат запросов
Метод всегда POST по HTTPS. Токен и другие специальные параметры передаются в HTTP-заголовках, а входные и выходные структуры — в теле запроса и ответа в формате JSON или SOAP/XML.
Важно знать
- Справка описывает только общие принципы. Конкретные методы, лимиты и баллы API находятся в отдельном руководстве разработчика версии 5 и в разделе частых вопросов; в скачанном тексте их нет.
- В справке не нашли: сроки рассмотрения заявки на доступ, критерии одобрения и перечень методов, недоступных в API.