Как получить доступ к API Яндекса

Клиенты часто спрашивают, как мы научили Foster находить ошибки в аккаунтах Яндекс.Директ. Все дело в том, что у нашего сервиса есть доступ к API Яндекса. Но, как известно, нельзя так просто взять и начать работу с API Яндекс.Директ. Разработчику необходимо пройти процедуру регистрации приложения. В этом посте я хочу пошагово рассказать, как мы регистрировали приложение для полноценной работы с Директом.

Кто может получить доступ к API?

Запрос к API выполняется от имени пользователя Директа — рекламодателя или рекламного агентства. В запросе необходимо указывать авторизационный токен — специальный код, разрешающий приложению операции с данными этого пользователя.

Создание нового приложения

В самом начале необходимо зарегистрировать новое приложение. Для этого переходим на страницу OAuth, заполняем необходимые поля, сохраняем. Этот шаг вполне прозрачен. Далее необходимо подать заявку на доступ к API.

На всякий случай напоминаю, что список всех поданных заявок можно посмотреть здесь.

Заявка на тестовый доступ

На первых этапах работы большинству разработчиков, скорее всего, будет достаточно заявки на ограниченный доступ к API Директа. Он включает в себя только доступ к «Песочнице». Получить подтвержденную заявку на тестовый доступ несложно:

Кликаем по кнопке «Новая заявка».
Выбираем «Тестовый доступ».
Выбираем из списка свое приложение, созданное на первом шаге и заполняем необходимые поля (на этом этапе можно особо не сочинять, достаточно общих сведений).

С вероятностью в 98% ваша заявка будет одобрена.

В оставшихся двух процентах случаев Яндекс сочтет, что приложение будет наносить вред рекламным кампаниям и отклонит заявку.

Заявка на полный доступ

Однако для запуска полноценного сервиса тестового доступа мало. Для получения полного доступа заходим на страницу редактирования заявки и кликаем по ссылке «Оформить заявку на полный доступ». Далее нужно проявить все свои писательские скиллы при заполнении поля «Опишите схему взаимодействия вашего приложения с Директом».

Сразу скажу, что общие фразы Яндекс не промодерирует. Заявку отклонит, а в комментариях попросит более подробно описать работу системы.

Детальный перечень того, что нужно указать в описании: 1. Детальное описание системы. 2. Перечислить весь список методов API, к которым планируется обращение системы. 2.1. Указать, с какой периодичностью методы API будут использоваться. 2.2. Почему выбраны именно эти методы, какие задачи системы они решают. 2.3. Как обработаны ошибки, которые могут возникнуть при обращении к методам API. 3. Подробно описать, как система проверяет лимиты Директа (а их немало), и что происходит при превышении лимитов. Тут самое главное упомянуть, что мы сразу перестаем ломиться к API, как только вышли за грани дозволенного. Можно кинуть пару строк кода с обработкой исключений по превышению лимитов.

Список всех лимитов можно найти в справке Яндекса.

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

На финише мы получили систему Foster в том виде, в котором вы её знаете. Сегодня клиенты сервиса, подключив соответствующие алгоритмы, могут с легкостью находить ошибки в Яндекс.Директ и исправлять их до того, как они навредят рекламной кампании. Кстати, с результатами интеграции сервиса с услугой [PPC 2.0] от Netpeak можно познакомиться в кейсе.