Skip to main content

Заголовки запроса

string
required
API токен сервисного пользователя в формате Bearer. Получите токен в панели администратора школы. Формат: Bearer YOUR_TOKEN.
string
required
Уникальный идентификатор продавца в системе. Используется для разграничения доступа между разными продавцами.
string
required
Уникальный идентификатор школы в системе. Определяет контекст выполнения операции.

Как это работает

Генерация отчета выполняется через асинхронный workflow. Процесс состоит из двух шагов:
1

Создание задачи на генерацию

Отправьте POST запрос на /saas/v2/query-export/generate с указанием типа отчета, переменных фильтрации и формата. В ответ вы получите объект с полем payload, содержащим uuid — идентификатор для отслеживания результата.
2

Получение результата

Отправляйте GET запрос на
/saas/v2/workflow-execution/:executionUuid/result,
подставив uuid из первого шага. Повторяйте запрос до тех пор, пока status не станет Completed (или Failed).

Создание запроса на выгрузку

Rate limit: 100 запросов в час.

Параметры запроса

string
required
Тип отчета. Определяет, какие данные будут выгружены. Доступные значения:
object
required
Переменные для запроса: фильтры и сортировка. Структура зависит от выбранного type. Подробнее — на странице конкретного типа отчета.
string
Формат выходного файла. По умолчанию — EXPORT_FORMAT_XLSX.
  • EXPORT_FORMAT_XLSX — Excel (.xlsx)
  • EXPORT_FORMAT_CSV — CSV (.csv)
  • EXPORT_FORMAT_JSON — JSON (.json)

Поля ответа

boolean
Результат выполнения запроса.
number
HTTP-код ответа (например, 201).
object
Объект задачи генерации.

Требования к правам доступа

Для генерации отчетов требуется авторизация и доступ к SaaS API школы.
Сервисный пользователь должен быть аутентифицирован по токену и иметь соответствующие права доступа к указанной школе.

Обновлено: 2026-07-08 06:37 UTC