Skip to main content

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

string
обязательно
API-токен сервисного пользователя в формате Bearer YOUR_TOKEN. Токен выпускает владелец школы в кабинете: Управление → Школа → Для разработчиков → API-ключи — подробнее в разделе «Аутентификация».
integer
обязательно
Числовой ID продавца — аккаунта, которому принадлежит школа. Скопируйте его на странице API-ключи в карточке «Данные для интеграции → Идентификаторы». По этому ID проверяются права токена.
integer
обязательно
Числовой ID школы, берётся там же, где Seller-Id. Значение должно совпадать со школой продавца — иначе вернётся ошибка 400 с cause: "ForbiddenSchoolMismatch".

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

Используйте uuid, полученный при создании задачи на генерацию. Отправляйте запрос периодически (polling) с интервалом 2–5 секунд, пока status не станет Completed или Failed. Этот метод не ограничен rate limit генерации, но частый опрос не ускоряет выгрузку.
Сразу после создания задачи payload может быть null: задача стоит в очереди и еще не сообщила о прогрессе. Продолжайте опрос. Если payload остается null для uuid, по которому вы уже получали статус, — срок хранения результата истек; запустите генерацию заново. Предусмотрите в коде общий таймаут опроса, чтобы не опрашивать неизвестный uuid бесконечно.

Параметры пути

string
обязательно
UUID задачи генерации, полученный из ответа POST /generate.

Поля ответа

boolean
Результат выполнения запроса.
number
HTTP-код ответа (например, 200).
object | null
Данные о прогрессе и результате генерации. null, если задача еще не начала выполняться, если задача с таким executionUuid не найдена или срок хранения результата истек.
Результат хранится 24 часа после завершения генерации. После этого метод возвращает payload: null — чтобы получить данные снова, запустите генерацию заново.

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

Требуется аутентификация по токену. Отдельных прав метод не требует: права на данные проверяются при генерации (см. права по типам отчетов).

Обновлено: 2026-09-25 13:43 UTC