Как подготовить внешнее приложение
Чтобы Трекер мог обмениваться данными с приложением, необходимо настроить базовую функциональность связей: сетевой доступ и аутентификацию.
Чтобы в Трекере была доступна расширенная функциональность связей с вашим приложением, например отображение подробной информации о связанных объектах, нужно реализовать поддержку этих возможностей в приложении.
Настроить базовую функциональность связей
Сетевой доступ
Ваше приложение должно быть доступно по публичному адресу через интернет.
Аутентификация
Для аутентификации запросов из Трекера к внешнему приложению можно использовать один из вариантов:
-
Без аутентификации
-
OAuth
В заголовке передается токен для авторизации запроса из Трекера во внешнее приложение.
Управление связями в Трекере
Чтобы создавать или удалять связи с вашим приложением, используйте API Яндекс Трекера:
- Получить список внешних приложений.
- Получить список внешних связей задачи.
- Добавить внешнюю связь.
- Удалить внешнюю связь.
Настроить расширенную функциональность связей
Получение информации о связанном объекте
Чтобы отображать в интерфейсе Трекера подробную информацию о связанном объекте, приложение должно передавать эту информацию по запросу:
-
Метод: GET
-
URL:
scheme://host:port*{{remoteKey}}*
где
remoteKey
— ключ связанного объекта в приложении;*
— любая последовательность символов.
Например:
https://my-app.ru:8080/1234/info
Ожидаемый формат ответа: список параметров в формате JSON.
Параметр |
Тип |
Описание |
|
Строка |
Ключ объекта. Обязательный. |
|
Строка |
Название объекта. Обязательный. |
|
Строка |
URL значка. Необязательный. |
|
Объект |
Статус объекта. Необязательный.
|
|
Объект |
Резолюция. Необязательный.
|
|
Объект |
Исполнитель. Необязательный.
|
|
Строка |
Дата и время обновления в формате |
|
Строка |
Дедлайн в формате |