Как получить токен Яндекс Метрики и Вебмастера через OAuth

Когда программе или нейросети нужно читать данные вашей Метрики, ей выдают токен. Это длинная строка, которая подтверждает, что доступ разрешили вы. Один токен подходит сразу для Метрики и Вебмастера.

Получается он через собственное приложение в кабинете OAuth Яндекса. Само приложение ничего не делает, оно нужно как оформление доступа. Ниже весь путь по шагам.

Как это устроено

Яндекс не отдаёт токен напрямую. Сначала вы регистрируете приложение и перечисляете права, которые оно может запросить. Потом открываете ссылку со своим ClientID, подтверждаете доступ, и Яндекс показывает токен.

Шаг 1. Создайте приложение

1. Откройте oauth.yandex.ru, предварительно войдя в свой Яндекс ID.
2. Нажмите «Создать». Яндекс спросит, какое приложение нужно.
3. Выберите «Для доступа к API или отладки» и нажмите «Перейти к созданию».

1. Введите название сервиса. Оно нужно только вам, подойдёт любое понятное.
2. В поле для связи укажите рабочую почту. Яндекс будет присылать на неё уведомления об изменениях.
3. Перейдите к блоку «Доступ к данным».

Шаг 2. Выберите права

В поле «Название доступа» впишите metrika, и Яндекс покажет все возможные права для этого API. Отметьте нужные. Затем то же самое сделайте со словом webmaster. Когда всё выбрано, прокрутите вниз и нажмите «Создать приложение».

В карточке приложения, в блоке «Запрашиваемые права», видно, что именно можно забрать через API.

• Метрика. Создание счётчиков, управление сегментами, загрузка данных, статистика, расходы.
• Вебмастер. Информация о внешних ссылках, добавление сайтов, статус индексирования.

Какие права выбирать

Права лучше давать по задаче. Если вам нужно только смотреть цифры, хватит прав на чтение статистики. Для управления счётчиками, целями и фильтрами в списке есть отдельные права на запись.

Я выбираю все, потому что нейросеть у меня работает и со статистикой, и со счётчиками. Если у вас задача проще, лишнего не берите. Чем меньше прав у токена, тем меньше он может натворить, если попадёт не в те руки.

Шаг 3. Получите токен

Токен выдаётся по специальной ссылке. Возьмите шаблон и подставьте в него свой ClientID. Подробнее про такой способ есть в документации Метрики.

1. Откройте карточку приложения и скопируйте ClientID. Поле Client secret не нужно, его не трогайте.
2. Подставьте ClientID в шаблон вместо заглушки и откройте ссылку в браузере.
3. Яндекс попросит ещё раз войти в аккаунт. Войдите и подтвердите доступ.
4. На странице появится длинная строка. Это и есть токен. Скопируйте его целиком и сохраните в файл.

Ссылку с шаблоном я тоже держу в файле. В документации она где-то есть, но второй раз искать не хочется.

Токен выглядит так. Значение выдуманное, оно нигде не работает.

Настоящий токен тоже начинается на y0 и бывает ещё длиннее.

Как проверить, что токен работает

Подставьте свой токен. В ответ должен прийти список ваших счётчиков Метрики.

Для Вебмастера токен тот же, меняется только адрес API. Проще всего попросить нейросеть сделать этот запрос, как я показываю в статье про подключение нейросети.

Как токен используется в запросах

Токен передаётся в заголовке запроса после слова OAuth, как в примере выше. Если токен неверный, Яндекс отвечает ошибкой доступа. У меня с неверным токеном пришёл код 403. Это самый частый признак того, что токен скопирован не целиком.

Чтобы читать данные счётчика, у вас должен быть доступ к нему. Владелец, гостевой доступ на просмотр или гостевой доступ на редактирование, если нужно управлять. Как выдать такой доступ, я описывал в отдельной статье.

Что может пойти не так