Подготовить внешнее приложение
Чтобы Tracker мог обмениваться данными с приложением, необходимо настроить сетевой доступ и аутентификацию.
Чтобы в Tracker была доступна расширенная функциональность связей с вашим приложением, например отображение подробной информации о связанных объектах или создание связей во внешнем приложении по запросу из Tracker, нужно реализовать поддержку этих возможностей в приложении.
Сетевой доступ
Ваше приложение должно быть доступно по публичному адресу через интернет.
Аутентификация
Для аутентификации запросов из Tracker к внешнему приложению можно использовать один из вариантов:
-
Без аутентификации
-
OAuth
В заголовке передается токен пользователя, от имени которого выполняется запрос к приложению.
Получение информации о связанном объекте
Чтобы отображать в интерфейсе Tracker подробную информацию о связанном объекте, приложение должно передавать эту информацию по запросу:
-
Метод: GET
-
URL:
scheme://host:port*{{remoteKey}}*где
remoteKey— ключ связанного объекта в приложении;*— любая последовательность символов.
Например:
https://my-app.ru:8080/1234/info
Ожидаемый формат ответа: список параметров в формате JSON
| Параметр | Тип | Описание |
|---|---|---|
key |
Строка | Ключ объекта. Обязательный. |
summary |
Строка | Название объекта. Обязательный. |
iconUrl |
Строка | URL иконки. Необязательный. Используется в том случае, если для объектов в определенном статусе нужно отображать другую иконку. |
status |
Объект | Статус объекта. Необязательный. Содержит поля:
|
resolution |
Объект | Резолюция. Необязательный. Содержит поля:
|
assignee |
Объект | Исполнитель. Необязательный. Содержит поля:
|
updated |
Строка | Дата и время обновления в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Необязательный. |
deadline |
Строка | Дедлайн в формате YYYY-MM-DDThh:mm:ss.sss±hhmm. Необязательный. |
Создание связей в приложении по запросу из Tracker
Когда в Tracker создается связь с внешним объектом, Tracker может отправить в приложение запрос, чтобы создать в приложении дублирующую связь. Для этого приложение должно поддерживать создание связи по запросу:
-
Метод: POST.
-
URL: определяет разработчик приложения.
-
Тело запроса: список параметров в формате JSON
Параметр Тип Описание issueKeyСтрока Ключ задачи в Tracker. entityIdsМассив строк Идентификаторы объектов в приложении, связанных с задачей.
Удаление связей в приложении по запросу из Tracker
Когда в Tracker удаляется связь с внешним объектом, Tracker может отправить в приложение запрос, чтобы удалить эту связь из приложения. Для этого приложение должно поддерживать удаление связи по запросу:
-
Метод: DELETE
-
URL:
scheme://host:port*{{issueKey}}*{{remoteKey}}|{{remoteKey}}*{{issueKey}}*где:
-
issueKey— ключ задачи в Tracker; -
remoteKey— ключ связанного объекта в приложении; -
*— любая последовательность символов.
Ключ задачи и ключ объекта могут быть указаны в любом порядке.
Например:
https://my-app.ru:8080/links/?action=del&ticket=TEST-123&obj=1234 -