Документация TMS DoQA

Тема

Публичный API ​

Через публичный API можно работать с тест-кейсами, чек-листами, прогонами и баг-репортами из скриптов и CI. Список методов с описанием параметров и возможностью отправить запрос прямо из браузера собран в интерактивном справочнике «Публичное API DOQA».

Доступ к справочнику ​

Нажмите на свое имя в правом верхнем углу и в открывшемся меню выберите пункт «Public API». Справочник откроется в новой вкладке.

Доступ к справочнику

Слева — список методов по группам, справа — блоки «SERVER» (адрес, на который уйдут запросы), «AUTHENTICATION» (токен) и «CLIENT LIBRARIES» (готовый фрагмент запроса для Shell, Ruby, Node.js, PHP, Python). Ссылка «Download OpenAPI Document» отдает спецификацию OpenAPI 3.0: ее можно передать генератору клиентов. Переключатель «RU»/«EN» в правом верхнем углу меняет язык описаний и названий групп.

Список методов

Что доступно через API ​

Методы сгруппированы по разделам (в скобках — название группы в английской версии справочника):

ГруппаЧто в ней
«Авторизация» (Authorization)получение токена по логину и паролю
«Тест-кейсы» (Test Cases)тест-кейсы: создание, чтение, изменение, копирование, список, выгрузка в xlsx, удаление в корзину
«Чек-листы» (Checklists)чек-листы: тот же набор операций
«Прогоны» (Runs)прогоны: создание, список, детали, изменение, смена статуса, элементы прогона, комментарии, полный отчет, удаление в корзину
«Баги» (Bugs)баг-репорты прогона и список баг-репортов пространства
«Статистика» (Statistics)данные дашборда: артефакты, тренды прогонов, активность пользователей
«Импорт» (Import)импорт проекта и статус импорта
«Автотесты» (Autotests)создание прогона из отчета автотестов

Совет

Метод POST /api/runs/from-autotest-report — исключение. Он авторизуется не вашим токеном, а токеном интеграции проекта, который передается в теле запроса. Этот токен создается отдельно, см. Создание API-токена.

API-токены ​

Персональный API-токен — основной способ авторизации для скриптов и CI: он не привязан к сессии и не истекает. Токены создаются в вашем профиле.

  1. Нажмите на свое имя в правом верхнем углу и выберите пункт «Профиль».
  2. Откройте раздел «API-токены» и нажмите на кнопку «Создать API-токен».
  3. В поле «Название токена» введите название (до 255 символов) и нажмите «Создать».
  4. В окне «API-токен создан» скопируйте значение токена и нажмите «Скопировал, закрыть».

Внимание

Значение токена показывается один раз: «Скопируйте токен сейчас. После закрытия этого окна токен больше нельзя будет просмотреть.» Если вы его не сохранили, токен придется удалить и создать новый.

Раздел «API-токены»

В таблице токенов видно:

  • «Имя» — название токена, его можно изменить;
  • «Токен» — только последние 4 символа значения;
  • «Создан» — дата и время создания;
  • «Последнее использование» — когда токеном последний раз обращались к API; прочерк, если токеном ни разу не пользовались.

Один пользователь может иметь до 10 токенов. Когда лимит исчерпан, кнопка «Создать API-токен» становится неактивной с подсказкой о лимите. Удалите ненужный токен, чтобы создать новый.

Токен удаляется по кнопке с корзиной, удаление нужно подтвердить. Восстановить токен нельзя: все скрипты, которые им пользовались, перестанут авторизовываться.

Передавайте токен в заголовке:

Authorization: Bearer <токен>

Токен действует от имени пользователя, которому он принадлежит, и дает те же права.

Авторизация в справочнике ​

Чтобы отправлять запросы прямо со страницы справочника, вставьте персональный API-токен в поле «Bearer Token» блока «AUTHENTICATION».

Поле «Bearer Token»

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

Вместо персонального токена можно получить временный — по логину и паролю, методом POST /api/auth/user-login из группы «Авторизация». В отличие от персонального API-токена, он истекает: по умолчанию через 10 часов, в box-версии срок настраивает администратор. Когда это произойдет, получите новый тем же способом.