Skip to main content

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

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

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

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

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

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

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

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

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

POST /saas/v2/query-export/generate
Rate limit: 100 запросов в час.

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

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

​
Поля ответа

​
success
boolean
Результат выполнения запроса.
​
code
number
HTTP-код ответа (например, 201).
​
payload
object
Объект задачи генерации.
curl --location 'https://api.exode.biz/saas/v2/query-export/generate' \
  --header 'Seller-Id: {{ sellerId }}' \
  --header 'School-Id: {{ schoolId }}' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --data '{
    "type": "QUERY_EXPORT_TYPE_GROUP_MEMBER_FIND_MANY",
    "variables": {
      "filter": { "groupIds": [1, 2, 3] }
    }
  }'

{
  "success": true,
  "payload": {
    "id": 282,
    "uuid": "ac4140c9-12d3-4c1f-a7aa-d12f16c7bbdd",
    "status": "Processing",
    "isCompleted": false
  },
  "code": 201
}

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

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