Публичный API

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

Доступ к Swagger

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

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

Методы сгруппированы по разделам:

Группа	Что в ней
Authorization	получение токена по логину и паролю
Test Cases	тест-кейсы: создание, чтение, изменение, копирование, список, выгрузка в xlsx, удаление в корзину
Checklists	чек-листы: тот же набор операций
Runs	прогоны: создание, список, детали, изменение, смена статуса, элементы прогона, комментарии, полный отчет, удаление в корзину
Bugs	баг-репорты прогона и список баг-репортов пространства
Statistics	данные дашборда: артефакты, тренды прогонов, активность пользователей
Import	импорт проекта и статус импорта
Autotests	создание прогона из отчета автотестов

Совет

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

API-токены

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

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

Примечание

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

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

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

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

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

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

Authorization: Bearer <токен>

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

Авторизация в Swagger

Для ручной работы в Swagger удобнее получить временный токен по логину и паролю. В отличие от персонального API-токена, он истекает (по умолчанию через 10 часов — в box-версии срок настраивает администратор); когда это произойдет, получите новый тем же способом.

Вместо шагов 1 и 2 можно сразу нажать «Authorize» и вставить персональный API-токен.

Шаг 1: Получение токена авторизации

1. Раскройте пункт POST /api/auth/user-login и нажмите «Try it out».

   

2. Укажите логин и пароль вашей учетной записи и нажмите «Execute».

   

3. Скопируйте значение полученного токена из ответа.

   

Шаг 2: Авторизация с токеном

1. Нажмите на кнопку «Authorize» в виде замка.

   

2. Вставьте скопированный токен и нажмите на кнопку «Authorize».

   

После этого вам станет доступна отправка запросов, содержащихся в Swagger.