Перейти к основному контенту

OAuth-токен для Яндекс Метрики

1. Зарегистрируйте приложение в Яндекс OAuth

    1. Перейдите на страницу регистрации приложений Яндекса: https://oauth.yandex.ru/client/new.Яндекса.
    2. Войдите в свой аккаунт Яндекса, если вы еще не авторизованы.

    2. Создайте новое приложение

    • Название приложения: Укажите— укажите понятное название вашего приложения или проекта.проекта;
    • Описание: Кратко— кратко опишите назначение приложения (опционально).;
    • Платформы: Выберите— выберите платформу, например, "Веб-сервисы".сервисы;
    • Callback URI :— Еслиесли требуется, укажите URL для обратного вызова (для серверных приложений это не обязательно).

    3. Укажите права доступа (Scope)

      1. В разделе "Доступ к данным"данным выберите необходимые права для работы с Яндекс Метрикой:
        • Яндекс Метрика (metrika):
          • Метрика: чтение статистики
         — для доступа к статистике.статистике;
      2. Метрика: редактирование счетчиков — если нужно создавать или изменять счетчики.счетчики;
      3. Метрика: управление конфигурацией — для управления целями, фильтрами и прочими настройками.настройками;
      4. Убедитесь, что выбранные права соответствуют вашим потребностям.

      4. Сохраните приложение

        1. Нажмите кнопку "Создать приложение"приложение.
        2. После сохранения вы будете перенаправлены на страницу с информацией о вашем приложении.

        5. Получите идентификаторы

        • ID приложения (Client ID): Уникальный— уникальный идентификатор вашего приложения.приложения;
        • Пароль приложения (Client Secret): Секретный— секретный ключ вашего приложения.

        Важно! Бережно храните Client Secret и не передавайте его третьим лицам.

        6. Получите OAuth-токен

        Существует два способа получения OAuth-токена: вручную через веб-интерфейс или программно через OAuth-протокол.

        Способ 1: Получение токена через веб-интерфейс (для личного использования)

          1.

          Перейдите по ссылке для получения токена, заменив YOUR_CLIENT_ID на ваш Client ID:


          https://oauth.yandex.ru/authorize?response_type=token&client_id=YOUR_CLIENT_ID&scope=metrika

          2.

          Выберите аккаунт Яндекса, для которого хотите получить токен.

          3.

          Разрешите доступ приложению, нажав кнопку "Разрешить"Разрешить.

          4.

          После этого вы будете перенаправлены на указанный Callback URI, а в адресной строке будет содержаться ваш OAuth-токен.

          Пример адресной строки:

          https://your-callback-url.com/#access_token=YOUR_OAUTH_TOKEN&token_type=bearer&expires_in=31536000

            5.

            Скопируйте значение access_token — это и есть ваш OAuth-токен.

            Способ 2: Получение токена программно через OAuth-протокол

              1.

              Сформируйте запрос на получение кода авторизации:авторизации:

              https://oauth.yandex.ru/authorize?response_type=code&client_id=YOUR_CLIENT_ID&scope=metrika

              2.

              Получите код авторизации после разрешения доступа.

              3.

              Обменяйте код на токен с помощью POST-запроса к API:

              POST https://oauth.yandex.ru/token

              Параметры запроса:

              • grant_type=authorization_codeauthorization_code;
              • code=AUTHORIZATION_CODE (полученный на предыдущем шаге);
              • client_id=YOUR_CLIENT_IDYOUR_CLIENT_ID;
              • client_secret=YOUR_CLIENT_SECRETYOUR_CLIENT_SECRET.

              Пример запроса с использованием curl:curl:


              curl -X POST https://oauth.yandex.ru/token \
  -d 'grant_type=authorization_code' \
  -d 'code=AUTHORIZATION_CODE' \
  -d 'client_id=YOUR_CLIENT_ID' \
  -d 'client_secret=YOUR_CLIENT_SECRET'

              В ответе вы получите JSON с вашим OAuth-токеном:


              {
  "access_token": "YOUR_OAUTH_TOKEN",
  "expires_in": 31536000,
  "token_type": "bearer"
}

              7. Проверка токена (опционально)


                Вы можете проверить работоспособность токена, отправив тестовый запрос к API Яндекс Метрики:


                GET https://api-metrika.yandex.net/management/v1/counters

                Добавьте заголовок авторизации:авторизации:


                Authorization: OAuth YOUR_OAUTH_TOKEN

                Пример запроса с использованием curl:curl:


                curl -H "Authorization: OAuth YOUR_OAUTH_TOKEN" \
https://api-metrika.yandex.net/management/v1/counters

                Если токен действителен,действителен, вы получите список ваших счетчиков.

                8. Используйте OAuth-токен в вашем приложении

                  1. Сохраните токен в безопасном месте, например, в настройках вашего приложения или бота.
                  2. Передавайте токен в заголовках Authorization при запросах к API Яндекс Метрики.

                  Важные замечания

                  • Безопасность: Никогда— никогда не публикуйте ваш OAuth-токен и Client Secret в открытых источниках или репозиториях.репозиториях;
                  • Срок действия токена: По— по умолчанию токен действует один год (expires_in: 31536000 секунд). По истечении срока потребуется получить новый токен.токен;
                  • Отзыв токена: Вы— вы можете в любой момент отозвать токен в настройках своего аккаунта Яндекса в разделе "Приложения с доступом к аккаунту"аккаунту.