Работа с API

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

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

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

  • Открыть проект, перейти в раздел Автотесты и нажать Документация API.
  • В адресной строке браузера добавить постфикс /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 будет виден его результат.