Доступ к API

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

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

  1. Получить доступ к API
  2. Python-клиент

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

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

Чтобы получить доступ к API Яндекс Трекера:

  1. Зарегистрируйте приложение и настройте для него доступ к чтению и записи в Трекере.

  2. Получите OAuth-токен для авторизации.

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

    • Host: https://api.tracker.yandex.net

    • Authorization: OAuth <ваш OAuth-токен>

    • X-Org-Id: <идентификатор вашей организации>

      Чтобы узнать идентификатор организации, перейдите на страницу настроек Трекера. Идентификатор указан в поле ID организации для API.

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

    Если доступ не был получен, запрос вернет ответ с кодом 401 Unauthorized.

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

Python-клиент

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

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

  1. Скачайте и установите на свой компьютер актуальную версию Python с сайта https://www.python.org/downloads.
  2. В командной строке вашей ОС выполните команду: 
    pip install yandex_tracker_client
  3. Получите OAuth-токен и идентификатор организации для доступа к API. Подробнее о том, как это сделать, читайте в документации API Трекера.
  4. Инициализируйте клиент в коде вашей программы: 
    from yandex_tracker_client import TrackerClient
    client = TrackerClient(token=<token>, org_id=<org_id>)

    Здесь <token> — ваш OAuth-токен, а <org_id> — идентификатор организации.

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