Как подготовить внешнее приложение

Чтобы Трекер мог обмениваться данными с приложением, необходимо настроить базовую функциональность связей: сетевой доступ и аутентификацию.

Чтобы в Трекере была доступна расширенная функциональность связей с вашим приложением, например отображение подробной информации о связанных объектах, нужно реализовать поддержку этих возможностей в приложении.

Настроить базовую функциональность связей

Сетевой доступ

Ваше приложение должно быть доступно по публичному адресу через интернет.

Аутентификация

Для аутентификации запросов из Трекера к внешнему приложению можно использовать один из вариантов:

  • Без аутентификации

  • OAuth

    В заголовке передается токен для авторизации запроса из Трекера во внешнее приложение.

Чтобы создавать или удалять связи с вашим приложением, используйте API Яндекс Трекера:

Настроить расширенную функциональность связей

Получение информации о связанном объекте

Чтобы отображать в интерфейсе Трекера подробную информацию о связанном объекте, приложение должно передавать эту информацию по запросу:

  • Метод: GET

  • URL: scheme://host:port*{{remoteKey}}*

    где

    • remoteKey — ключ связанного объекта в приложении;
    • * — любая последовательность символов.

    Например: https://my-app.ru:8080/1234/info

Ожидаемый формат ответа: список параметров в формате JSON.

Параметр

Тип

Описание

key

Строка

Ключ объекта. Обязательный.

summary

Строка

Название объекта. Обязательный.

iconUrl

Строка

URL значка. Необязательный.
Используется в том случае, если для объектов в определенном статусе нужно отображать другой значок.

status

Объект

Статус объекта. Необязательный.
Содержит поля:

  • name (строка) — название;
  • description (строка, необязательно) — описание.

resolution

Объект

Резолюция. Необязательный.
Содержит поля:

  • name (строка) — название;
  • description (строка, необязательно) — описание.

assignee

Объект

Исполнитель. Необязательный.
Содержит поля:

  • trackerUid(длинное целое число, необязательно) — идентификатор пользователя Трекера;
  • passportUid (длинное целое число, необязательно) — идентификатор пользователя Яндекс ID (бывшего Паспорта);
  • login (строка, необязательно) — логин.

updated

Строка

Дата и время обновления в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Необязательный.

deadline

Строка

Дедлайн в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Необязательный.