Интеграция с Яндекс Вики

Интеграция с Яндекс Вики позволяет связывать ручные тест-кейсы ТестОпс с требованиями, задокументированными на страницах Яндекс Вики.

Важно

Если ваш администратор Яндекс Вики отключил доступ к API, настроить интеграцию не получится. Подробнее см. официальную документацию Яндекс Вики.

Примечание

Чтобы настроить или удалить любую интеграцию ТестОпс с внешней системой, необходима глобальная роль «Администратор» в инстансе ТестОпс и, как правило, права администратора инстанса внешней системы.

Настройка интеграции и подключений с Яндекс Вики

Чтобы настроить интеграцию с Яндекс Вики:

1. Создайте OAuth2-токен в Яндекс.
2. Получите идентификатор организации в Яндекс.
3. Подключите интеграцию с Яндекс Вики на уровне инстанса ТестОпс.
4. Добавьте настроенное подключение к Яндекс Вики в проект ТестОпс.

1. Создайте OAuth2-токен в Яндекс

1. Создайте OAuth2-токен в Яндекс, добавив разрешение Чтение из Вики.
2. Сохраните токен в безопасном месте, он понадобится для подключения интеграции с Яндекс Вики в ТестОпс.

2. Получите идентификатор организации в Яндекс

Воспользуйтесь одним из способов в зависимости от организации в Яндекс, в которой используется Яндекс Вики:

1. Перейдите в кабинет организации Яндекс 360.
2. Перейдите в раздел Общие настройки → Профиль организации.
3. Под названием организации скопируйте ее идентификатор.

Сохраните идентификатор организации в безопасном месте, он понадобится для подключения интеграции с Яндекс Вики в ТестОпс.

3. Подключите интеграцию с Яндекс Вики на уровне инстанса ТестОпс

1. Перейдите в ваш инстанс ТестОпс → раздел Администрирование → Интеграции.

2. Нажмите Добавить интеграцию.

3. В списке доступных интеграций выберите Яндекс Вики.

4. Заполните поля:

   • Название подключения — введите название, которое поможет вам распознать интеграцию (например, Яндекс Вики production).

   • Endpoint — введите URL-адрес вашего инстанса Яндекс Вики (например, https://wiki.yandex.ru).

   • Endpoint для вызовов API — введите URL-адрес API Яндекс Вики:

     • для облачной версии Яндекс Вики укажите https://api.wiki.yandex.net;
     • для серверной версии Яндекс Вики укажите собственный эндпоинт.

   • Тип учетных данных — нажмите на выпадающий список и выберите тип учетных данных Яндекс Вики, который будет поддерживать интеграция:

     • Все (глобальные и проектные) — интеграция может работать как с глобальными, так и с проектными учетными данными;
     • Только глобальные — интеграция может работать только с глобальными учетными данными;
     • Только проектные — интеграция может работать только с проектными учетными данными.

     Примечание

     Подробнее о поддерживаемых типах учетных данных см. Интеграции с внешними системами → Учетные данные внешних систем.

5. Если ваш инстанс Яндекс Вики использует самоподписанный SSL-сертификат, уберите галочку напротив Проверка SSL-сертификата.

6. Если интеграция может работать с глобальными учетными данными Яндекс Вики, в секции Глобальные учетные данные:

   1. Введите идентификатор организации, который вы сохранили на шаге 2.
   2. Введите OAuth2-токен, который вы сохранили на шаге 1.

7. Нажмите Добавить подключение.

В разделе Администрирование → Интеграции появится интеграция с Яндекс Вики с одним автоматически созданным подключением.

4. Добавьте настроенное подключение к Яндекс Вики в проект ТестОпс

Чтобы добавить настроенное подключение к Яндекс Вики в нужный проект ТестОпс, воспользуйтесь одним из способов:

1. В ТестОпс перейдите в раздел Администрирование → Интеграции.

2. В списке настроенных интеграций найдите и откройте интеграцию с Яндекс Вики.

3. В списке настроенных подключений найдите и откройте ваше подключение к Яндекс Вики.

4. Нажмите Добавить в проект.

5. В списке доступных проектов выберите нужный проект ТестОпс.

6. Если интеграция может работать и с глобальными, и с проектными учетными данными Яндекс Вики, в поле Тип учетных данных нажмите на выпадающий список и выберите вариант, который будет использоваться в проекте:

   • Проектные — использовать проектные учетные данные для подключения к Яндекс Вики;
   • Глобальные — использовать глобальные учетные данные для подключения к Яндекс Вики.

7. Если интеграция будет работать с проектными учетными данными Яндекс Вики, в секции Проектные учетные данные:

   1. Введите идентификатор организации, который вы сохранили на шаге 2.
   2. Введите OAuth2-токен, который вы сохранили на шаге 1.

8. Нажмите Добавить в проект.

Удаление подключений и интеграции с Яндекс Вики

Вы можете удалить подключение к интеграции с Яндекс Вики двумя способами — на уровне отдельного проекта (через настройки проекта) или на уровне всего инстанса ТестОпс (через раздел Администрирование).

Удаление подключения на уровне проекта

Важно

Последствия удаления всех подключений из интеграции с Яндекс Вики на уровне проекта:

• Подключения к интеграции с Яндекс Вики перестанут отображаться в списке подключений проекта, но продолжат работать в других проектах инстанса, в которых они были добавлены, и сохранятся в разделе Администрирование → Интеграции.
• Интеграция с Яндекс Вики перестанет отображаться в списке интеграций проекта, но сохранится в разделе Администрирование → Интеграции.
• Все связи со страницами Яндекс Вики, которые относятся к интеграции, будут сохранены в сущностях ТестОпс, но вы не сможете создавать новые связи для этого проекта.

Чтобы удалить подключение на уровне проекта:

1. Перейдите в ваш проект ТестОпс → раздел Настройки → Интеграции.
2. В списке настроенных интеграций найдите и откройте интеграцию с Яндекс Вики.
3. Напротив нужного подключения к Яндекс Вики нажмите ⋯ → Удалить → Да, удалить.

Подключение перестанет работать в вашем проекте.

Удаление подключения на уровне инстанса

Важно

Последствия удаления всех подключений из интеграции с Яндекс Вики на уровне инстанса:

• Подключения и интеграция с Яндекс Вики будут полностью удалены.
• Все связи со страницами Яндекс Вики, которые относятся к интеграции, будут удалены из сущностей ТестОпс. Это действие необратимо — восстановить удаленные ссылки будет невозможно.

Чтобы удалить подключение на уровне инстанса:

1. Перейдите в ваш инстанс ТестОпс → раздел Администрирование → Интеграции.
2. В списке настроенных интеграций найдите и откройте интеграцию с Яндекс Вики.
3. В списке настроенных подключений откройте карточку нужного подключения и напротив названия каждого проекта нажмите ⋯ → Удалить из проекта → Да, удалить.
4. Нажмите Назад в интеграцию, чтобы вернуться к списку подключений.
5. Напротив нужного подключения к Яндекс Вики нажмите ⋯ → Удалить → Да, удалить.

Подключение перестанет работать во всех проектах инстанса.