Главная API Получить каталог тестов

Получить каталог тестов

Обновлено Apr 27, 2026

GET /v1/tests возвращает каталог тестов, доступных текущей компании: системные тесты и собственные тесты компании. Integrated synthetic-тесты SCORM/CMI5/xAPI в ответ не входят.

Endpoint

Метод URL
GET https://smartway.pro/api/v1/tests

Назначение

Получить список тестов, которые можно использовать для тестирования кандидатов или сотрудников.

Предварительные условия

Требование Значение
Авторизация Authorization: Bearer <access_token>
Scope tests.read
Tenant context Определяется сервером из Bearer token
idCompany Не передаётся внешним клиентом

Запрос

Параметры не передаются.

curl пример

curl -X GET 'https://smartway.pro/api/v1/tests' \
  -H 'Authorization: Bearer <access_token>' \
  -H 'Accept: application/json'

Ответ

Успешный ответ: 200 OK.

{
  "data": [
    {
      "testId": 5,
      "name": "Conflict Test",
      "active": true,
      "companyOwned": false,
      "questionCount": 30
    },
    {
      "testId": 200001,
      "name": "Adaptive Sales",
      "active": true,
      "companyOwned": true,
      "questionCount": 12
    }
  ],
  "meta": {
    "total": 2
  }
}

Поля ответа

Поле Тип Описание
data object[] Список тестов, доступных текущей компании
data[].testId int64 ID теста
data[].name string Название теста
data[].active boolean Признак активности теста
data[].companyOwned boolean true, если тест принадлежит текущей компании
data[].questionCount int32 Количество вопросов в тесте
meta.total int32 Общее количество тестов в ответе

Бизнес-логика

  • Компания определяется из Bearer token.

  • Возвращаются системные тесты и тесты, принадлежащие текущей компании.

  • Поле companyOwned показывает, принадлежит ли тест текущей компании.

Пограничные случаи

Сценарий Поведение API
Тест является integrated synthetic-тестом SCORM/CMI5/xAPI Тест не входит в каталог
В токене нет company context API возвращает 403 Forbidden

Ошибки

HTTP status Причина
401 Unauthorized Bearer token отсутствует или невалиден
403 Forbidden Недостаточно прав или токен без company context
500 Internal Server Error Неожиданная ошибка LMS Smart Way
503 Service Unavailable Сбой внутренней интеграции LMS Smart Way

Использование

Используйте endpoint, чтобы получить доступные testId перед созданием приглашения или настройкой фильтров отчётов.

Типичные ошибки

Ошибка Как избежать
Использование токена без tests.read Проверьте scope API key
Передача idCompany в запросе Не передавайте idCompany; компания определяется из токена
Ожидание SCORM/CMI5/xAPI synthetic-тестов в каталоге Этот endpoint такие тесты не возвращает

FAQ

Нужно ли передавать idCompany?

Нет. Компания определяется сервером из Bearer token.

Входят ли SCORM/CMI5/xAPI synthetic-тесты в ответ?

Нет. Они не входят в каталог GET /v1/tests.