Перейти к основному содержимому
Версия: 1.6.1

REST API TRON.ASOC

REST API TRON.ASOC позволяет выполнять те же действия, что и в веб-интерфейсе: создание и запуск проверок безопасности, работа с проектами, подключение интеграций, формирование отчетов и т.д.

Полный справочник API-эндпоинтов доступен на отдельной странице. Для каждого метода указаны параметры запроса, схемы данных, коды и тела ответов, а также готовая команда curl. Справочник собран на основе OpenAPI-спецификации продукта, которая доступна для скачивания.

Базовый URL: https://{host}/api/v1, где {host} — URL вашего TRON.ASOC. То же значение подставляется в поле host блока Сервер в справочнике.

warning

Отправить тестовый запрос прямо из справочника нельзя. Скопируйте команду curl и выполните ее в сети, из которой доступен ваш TRON.ASOC.

Способы аутентификации в REST API TRON.ASOC​

Аутентификация возможна одним из двух способов:

  • с помощью API-токена в заголовке API-Key;
  • с помощью токена в заголовке Authorization: Bearer {ваш_токен}.

Получение токена для заголовка Authorization: Bearer​

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

  1. Откройте терминал на своем ПК.
  2. Выполните команду, подставив адрес своей установки:
curl -X POST "https://{host}/api/v1/auth/login" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "имя_вашей_учетной_записи_в_TRON.ASOC",
    "password": "пароль"
  }'

После выполнения команда вернет следующий ответ:

{
    "id":"идентификатор_вашей_учетной_записи",
    "email":"ваш_адрес_электронной_почты",
    "username":"имя_вашей_учетной_записи_в_TRON.ASOC",
    "display_name":"ваше_отображаемое_имя",
    "access_token":"ваш_токен_для_авторизации",
    "ttl":0,
    "need_refresh_content":false
}

Для авторизации используйте значение из строки access_token.

Получение API-токена для заголовка API-Key​

Инструкция по получению токена доступна в разделе Получение API-токена.

Нашли ошибку или неточность?