Работа с API

Вы можете взаимодействовать с системой Test IT посредством открытого API. Методы API позволяют создавать и запускать автотесты, импортировать и экспортировать проекты с помощью .json-файлов, создавать рабочие элементы и многое другое. Описание методов API хранится в Swagger. Вы можете взаимодействовать с открытым API любым способом, например с помощью Postman.

Внимание!

Следующие API-методы устарели и перестанут поддерживаться (дата прекращения поддержки уточняется). Рекомендуем использовать обновленные методы, добавленные в документацию Swagger. Список устаревших API-методов представлен в таблице ниже.

Раздел SwaggerМетод
WorkItemget /api/v2/workItems/sharedSteps/{sharedStepId}/references
TestSuitespost /api/v2/testSuites/{id}/workItems/search
Sectionsget /api/v2/sections/{id}/workItems
Projectsget /api/v2/projects
get /api/v2/projects/{id}/workItems
post /api/v2/projects/{id}/export
post /api/v2/projects/{id}/export-by-testPlans
post /api/v2/projects/import
post /api/v2/projects/{id}/import

Переход в Swagger из интерфейса Test IT

Вы можете открыть Swagger из интерфейса Test IT двумя способами:

  • Нажмите значок Информация в правом верхнем углу окна, затем в выпадающем меню выберите Документация API.
    Доступ к документации API в Test IT TMS
  • В адресной строке браузера добавьте постфикс /swagger к адресу системы Test IT, затем перейдите по получившемуся адресу. Например, testit.software/swagger, где testit.software необходимо заменить на адрес системы вашей компании.

Авторизация

  1. Сгенерируйте приватный API-токен.
  2. Откройте Swagger. В открывшемся окне нажмите Authorize.
  3. В открывшемся диалоговом окне введите PrivateToken {API Secret Key}. Вставьте скопированный ранее секретный ключ API вместо {API Secret Key}.
  4. Нажмите Authorize.

После авторизации вы можете просматривать запросы и описания методов и делать запросы из Swagger. Для этого:

  1. Откройте интересующий вас запрос и нажмите Try it out около него.
  2. Заполните тело запроса.
  3. Нажмите Execute.

После успешного выполнения запроса в системе Test IT отобразится его результат.

Обновлено: