API ТестОпс

ТестОпс не предоставляет публичного API.

Описание всех API-методов, доступных в ТестОпс, расположено по URL-адресу https://<ваш домен ТестОпс>/swagger-ui.html:

• Все API-запросы полностью повторяют поведение интерфейса ТестОпс: каждый запрос, отправляемый через API, идентичен запросам, которые интерфейс отправляет на бэкенд.
• Чтобы использовать API, имитируйте запросы, которые выполняет интерфейс ТестОпс.

Ограничения по использованию API ТестОпс

Важно

Вы можете использовать все описанные API-методы в ваших приложениях за исключением методов для загрузки результатов тестов. Загрузка результатов — это проприетарный процесс, который может быть изменен в любое время без уведомления и без поддержки с нашей стороны.

Для загрузки результатов тестов мы рекомендуем использовать только созданные нами инструменты: CI-плагины (например, плагин для Jenkins) или allurectl. Эти инструменты всегда соответствуют актуальному процессу загрузки и обеспечивают стабильную производительность системы.

Структура страницы Swagger в ТестОпс и доступные API-методы

Режимы отображения API-методов

На странице Swagger в ТестОпс вы можете изменить отображение API-методов в зависимости от рассматриваемой функциональности ТестОпс. Для этого:

1. Перейдите на страницу Swagger в ТестОпс.

2. В правом верхнем углу нажмите на выпадающий список Select a definition.

3. Выберите нужный раздел:

   • Report Service — API-методы для создания, изменения и получения информации о сущностях ТестОпс (например, тест-кейсах, результатах тестов, запусках).
   • UAA Service — API-методы для управления правами доступа пользователей ТестОпс, добавления новых пользователей, а также для работы с лицензиями ТестОпс.
   • All Services — все доступные API-методы ТестОпс (объединение API-методов из разделов Report Service и UAA Service).

Тестовые API-запросы

Вы можете протестировать API-методы непосредственно на странице Swagger:

1. В списке доступных API-методов найдите описание нужного метода и разверните информацию о нем.
2. Справа от вкладки Parameters нажмите Try it out.

Вы увидите результат вызова метода и команду cURL, которую можно использовать для этого вызова.

Аутентификация в API-запросах

Когда на странице Swagger в ТестОпс вы нажимаете Try it out, Swagger автоматически использует cookie вашего браузера для аутентификации, дополнительных настроек в этом случае не требуется.

При разработке собственной интеграции вам необходимо сгенерировать Bearer-токен и использовать его для аутентификации ваших запросов к API ТестОпс.

Получение Bearer-токена для аутентификации в API-запросах

export ENDPOINT="https://testops.example.com"
export USER_TOKEN="ef06773a-544b-4f0b-ad53-5a11972c8b74"

echo "Obtaining jwt token"
JWT_TOKEN=$(curl -s -X POST "${ENDPOINT}/api/uaa/oauth/token" \
     --header "Expect:" \
     --header "Accept: application/json" \
     --form "grant_type=apitoken" \
     --form "scope=openid" \
     --form "token=${USER_TOKEN}" \
     | jq -r .access_token)

Использование Bearer-токена для аутентификации в API-запросах

echo "Getting user information"

curl -s -G "${ENDPOINT}/api/uaa/me" \
     --header "Accept: application/json" \
     --header "Authorization: Bearer ${JWT_TOKEN}"

Срок действия Bearer-токена

Полученный Bearer-токен имеет ограниченный срок действия, который по умолчанию составляет 1 час. По истечении этого срока вашему приложению нужно будет получить токен повторно.

Срок действия Bearer-токена можно изменить, используя параметр ALLURE_JWT_ACCESS_TOKEN_VALIDITY_SECONDS в настройках вашего инстанса ТестОпс.