Доступ к API

Для доступа приложений к Yandex Tracker API используется авторизация по протоколу OAuth 2.0.

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

В запросах к Tracker API указывайте заголовки:

• Host: api.tracker.yandex.net

• Authorization: OAuth <OAuth-токен> — при доступе по протоколу OAuth 2.0. Подробнее в разделе Получить доступ к API по протоколу OAuth 2.0.

  Authorization: Bearer <IAM-токен> — при доступе при помощи IAM-токена. Подробнее в разделе Получить доступ к API по IAM-токену.

  Например: Authorization: Bearer t1.ab123cd45*****************.

• X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

  • Используйте заголовок X-Org-ID, если к Tracker привязана организация Яндекс 360 для бизнеса.

  • Используйте заголовок X-Cloud-Org-ID, если к Tracker привязана организация Yandex Cloud Organization.

  Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

  Например: X-Org-ID: 1234***.

Получить доступ к API по протоколу OAuth 2.0

Протокол OAuth 2.0 позволяет приложениям работать с сервисами Яндекса от имени пользователя. С базовыми принципами OAuth, а также с особенностями реализации протокола в Яндексе вы можете ознакомиться в документации сервиса OAuth для Яндекс ID.

Чтобы получить доступ к Yandex Tracker API:

1. Зарегистрируйте в сервисе Яндекс OAuth приложение, к которому будет привязан токен для работы с API Tracker:

   1. Перейдите по ссылке https://oauth.yandex.ru/client/new/.

   2. В разделе Платформы приложения выберите платформу и укажите ее параметры.

      Если вы хотите протестировать работу приложения с API или отправлять запросы к API вручную, используйте отладочный токен. Для получения такого токена выберите Веб-сервисы, установите курсор в поле Redirect URI и в подсказке нажмите Подставить URL для отладки. В поле будет подставлено значение https://oauth.yandex.ru/verification_code.

   3. В разделе Доступ к данным добавьте разрешения для работы с API Tracker. Чтобы выбрать разрешение, начните вводить его название в поле Название доступа:

      • Запись в трекер (tracker:write) — все операции с данными: создание, удаление, редактирование.

      • Чтение из трекера (tracker:read) — только чтение данных.

   Скриншот

   

   Подробнее о регистрации приложения читайте в Справке Яндекс ID.

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

   1. В личном кабинете Яндекс OAuth выберите созданное ранее приложение и скопируйте его идентификатор из поля ClientID. Затем сформируйте ссылку для запроса токена:

      https://oauth.yandex.ru/authorize?response_type=token&client_id=<идентификатор_приложения>
      

   2. Перейдите по ссылке и скопируйте OAuth-токен.

   Совет

   Если для получения OAuth-токена вам требуется код подтверждения от пользователя, используйте инструкции в разделе Запрос OAuth-токена при помощи кода подтверждения.

3. Полученный токен используйте в заголовке Authorization в запросах к API Tracker. OAuth-токен предоставляет те же права, которые есть у аккаунта пользователя в Tracker. Например, если у пользователя нет прав на изменение настроек очереди, соответствующие запросы к API будут недоступны.

4. Чтобы проверить наличие доступа к API, выполните запрос информации о текущем пользователе.
   Если доступ не был получен, запрос вернет ответ с кодом 401 Unauthorized.

Получить доступ к API по IAM-токену

Если вы используете Tracker в составе организации Yandex Cloud, для авторизации в API можно использовать IAM-токен.

IAM-токен — уникальная последовательность символов, которая выдается пользователю после прохождения аутентификации. С помощью этого токена пользователь авторизуется в Yandex Tracker API и выполняет операции с ресурсами. Подробнее об этом способе аутентификации читайте в документации сервиса идентификации и контроля доступа.

• Как получить IAM-токен для аккаунта на Яндексе

• Как получить IAM-токен для федеративного аккаунта

Python-клиент

При разработке приложений на языке Python вы можете использовать пакет yandex_tracker_client — клиент, который облегчает работу с Tracker API.

Чтобы начать пользоваться клиентом:

1. Скачайте и установите на свой компьютер актуальную версию Python с сайта https://www.python.org/downloads/.

2. В командной строке вашей ОС выполните команду:

   pip install yandex_tracker_client
   

3. Получите OAuth-токен и идентификатор организации для доступа к API.

   Чтобы узнать идентификатор организации, перейдите на страницу Администрирование → Организации и скопируйте значение поля идентификатор.

4. Инициализируйте клиент в коде вашей программы:

from yandex_tracker_client import TrackerClient
client = TrackerClient(token='<OAuth-токен>', org_id='<идентификатор_организации>')

from yandex_tracker_client import TrackerClient
client = TrackerClient(token='<OAuth-токен>', cloud_org_id='<идентификатор_организации>')

В клиенте используйте такой же формат данных, как в API Tracker.

Подробнее о работе клиента и условиях использования читайте на его странице в GitHub: https://github.com/yandex/yandex_tracker_client.