Reezonly Space Platform API (1.0.0)

Download OpenAPI specification:

License: MIT

Руководство интеграций Reezonly Space — это главный источник информации, благодаря которому внешние CRM, CMS, ERP и маркетинговые системы быстро подключают программный доступ к Space API.

Здесь собраны схемы аутентификации, бизнес‑блоки пользователей, групп, курсов, сертификатов и отчетов, примеры запросов и схемы ответов. Документация рассказывает, как синхронизировать пользователей, подтянуть группы и права из вашей CRM, создавать курсы и выгружать отчеты — все через безопасный X-API-Key и понятные бизнес-сущности.

Что можно делать через API

Добавлять, изменять и удалять пользователей.
Назначать пользователям обучение.
Создавать группы, редактировать их и назначать им обучение.
Изменять пользовательские поля.
Выдавать сертификаты после завершения обучения.

Аутентификация

Для доступа к API необходимо использовать API Key в заголовке запроса:

X-API-Key: your_api_key_here

Базовый URL

https://your-space-domain.com/api/v1

Users.Operations

Базовые операции с пользователями

Назначение: CRUD для пользователей, управление статусами и ролями. Ключевые особенности:

Фильтрация по status (int), role, department.
Поддержка кастомных полей в view и update.
Асинхронное создание (через очередь).

Получить список пользователей

Возвращает список пользователей с пагинацией и расширенными фильтрами. Поддерживает сортировку и фильтрацию по группам, курсам и сумме оплат.

Authorizations:

BearerToken

query Parameters

page	integer >= 1 Default: 1 Example: page=1 Номер страницы для пагинации
per_page	integer [ 1 .. 100 ] Default: 20 Example: per_page=50 Количество элементов на странице (максимум 100)
username	string Поиск по имени или email
status	integer Enum: 0 10 20 30 Статус: 0=New, 10=Active, 20=Blocked, 30=Unconfirmed
position	string Фильтр по должности
department	string Фильтр по отделу
groupIds	Array of integers Фильтр по ID групп
courseIds	Array of integers Фильтр по ID курсов (имеет доступ)
sort	string Default: "-updated_at" Example: sort=-created_at Поле сортировки: username, email, position, department, status, courseCount, created_at, updated_at, payment_sum. Префикс '-' для убывания.

Responses

Response samples

200
422
500

Content type

application/json

{"success": true,
"meta": {"total": 150,
"page": 1,
"per_page": 20
},
"data": {"pagination": {"total": 150,
"page": 1,
"per_page": 20
},
"items": [{"id": 1,
"username": "john_doe",
"email": "user@example.com",
"department": "Marketing",
"position": "Manager",
"photo": "https://example.com/photo.jpg",
"status": 10,
"created_at": 1699459200,
"updated_at": 1699459200,
"role": "admin",
"educationAccess": true,
"courseCount": 5,
"payment_sum": 2999.99,
"groups": [{"id": 1,
"name": "Отдел продаж",
"description": "Сотрудники отдела продаж",
"parent_id": null,
"members_count": 25,
"hierarchy_level": 0,
"created_at": 1705316400
}
]
}
]
}
}

Получить список администраторов

Аналогичен методу index, но возвращает только пользователей с правами администратора.

Authorizations:

BearerToken

query Parameters

page	integer >= 1 Default: 1 Example: page=1 Номер страницы для пагинации
per_page	integer [ 1 .. 100 ] Default: 20 Example: per_page=50 Количество элементов на странице (максимум 100)
username	string Поиск по имени или email
sort	string Default: "-updated_at" Поле сортировки

Responses

Response samples

200
422
500

Content type

application/json

{"success": true,
"meta": {"total": 150,
"page": 1,
"per_page": 20
},
"data": {"pagination": {"total": 150,
"page": 1,
"per_page": 20
},
"items": [{"id": 1,
"username": "john_doe",
"email": "user@example.com",
"department": "Marketing",
"position": "Manager",
"photo": "https://example.com/photo.jpg",
"status": 10,
"created_at": 1699459200,
"updated_at": 1699459200,
"role": "admin",
"educationAccess": true,
"courseCount": 5,
"payment_sum": 2999.99,
"groups": [{"id": 1,
"name": "Отдел продаж",
"description": "Сотрудники отдела продаж",
"parent_id": null,
"members_count": 25,
"hierarchy_level": 0,
"created_at": 1705316400
}
]
}
]
}
}

Получить профиль пользователя

Возвращает детальную информацию о пользователе, включая курсы, сертификаты и кастомные поля.

Authorizations:

BearerToken

query Parameters

id

required

integer >= 1

Example: id=42

Идентификатор ресурса

Responses

Response samples

200
404
500

Content type

application/json

{"success": true,
"meta": {"total": 150,
"page": 1,
"per_page": 20
},
"data": {"item": {"id": 1,
"username": "john_doe",
"email": "user@example.com",
"department": "Marketing",
"position": "Manager",
"photo": "https://example.com/photo.jpg",
"status": 10,
"created_at": 1699459200,
"updated_at": 1699459200,
"role": "admin",
"educationAccess": true,
"courseCount": 5,
"payment_sum": 2999.99,
"groups": [{"id": 1,
"name": "Отдел продаж",
"description": "Сотрудники отдела продаж",
"parent_id": null,
"members_count": 25,
"hierarchy_level": 0,
"created_at": 1705316400
}
],
"phone": "+79991234567",
"waitRequest": [{ }
],
"certificates": [{"id": 45,
"number": "CERT-2024-001",
"created_at": 1727772000,
"course": {"id": 456,
"alias": "onboarding-2024",
"title": "Онбординг",
"type_id": 1,
"picture_thumbnail": "https://cdn.space/courses/456/thumb.png"
},
"user": {"id": 123,
"username": "Иван Иванов",
"email": "ivan@example.com"
},
"file": "https://s3.space/certificates/2024/cert-45.pdf",
"fields": [{"key": "username",
"value": "Иван Иванов"
}
],
"template": {"id": 2,
"name": "Gold Award",
"hide_for_student": false,
"file": "https://s3.space/templates/2/template.pdf",
"type": {"id": 1,
"name": "Course completion"
}
}
}
],
"courses": [{"id": 1,
"title": "example",
"status": 10,
"progress": 75.5,
"amount": 2999.99,
"group": "Group 1"
}
],
"userFields": [{"id": 1,
"name": "John Doe",
"title": "Advanced Python",
"type": 1
}
]
}
}
}

Создать пользователя

Создает нового пользователя. Пароль обязателен. Привязка к группам и курсам при создании не поддерживается (используйте отдельные методы).

Authorizations:

BearerToken

Request Body schema: multipart/form-data
required

username required	string Уникальное имя пользователя
email required	string <email> Электронная почта (должна быть уникальной)
password required	string Пароль пользователя
role	string Роль пользователя (admin, user и т.д.)
department	string Отдел или подразделение
position	string Должность пользователя

Responses

Response samples

201
422
500

Content type

application/json

{"success": true,
"meta": {"total": 150,
"page": 1,
"per_page": 20
},
"data": {"user_id": 1
}
}

Обновить пользователя

Обновляет данные профиля, включая кастомные поля.

Authorizations:

BearerToken

query Parameters

id

required

integer >= 1

Example: id=42

Идентификатор ресурса

Request Body schema: multipart/form-data
required

username	string Уникальное имя пользователя
email	string Электронная почта (должна быть уникальной)
department	string Отдел или подразделение
position	string Должность пользователя
password	string Пароль пользователя (оставьте пустым, чтобы не менять)
role	string Роль пользователя (admin, user и т.д.)

Responses

Response samples

200
403
422
500

Content type

application/json

{"success": true,
"meta": {"total": 150,
"page": 1,
"per_page": 20
},
"data": {"user_id": 1
}
}

Удалить пользователя(ей)

Удаляет одного или нескольких пользователей.

Authorizations:

BearerToken

query Parameters

ids	Array of integers Массив ID пользователей для удаления (опционально, если не передано - ошибка?)

Responses

Response samples

200
401
403
500

Content type

application/json

{"success": true,
"meta": {"total": 150,
"page": 1,
"per_page": 20
}
}

Справочник статусов

Возвращает список всех возможных статусов пользователей (New, Active, Blocked, Unconfirmed) с их ID для использования в фильтрах и при создании пользователей.

Authorizations:

BearerToken

Responses

Response samples

200
401

Content type

application/json

{"success": true,
"items": [{"id": 1,
"name": "John Doe"
}
]
}

Users.Courses

Управление курсами пользователя

Назначение: назначение и отзыв курсов. Особенности: методы add-course и delete-course работают асинхронно.

Назначить курс пользователю

Назначает один или несколько курсов одному или нескольким пользователям. Операция выполняется асинхронно. Если пользователь уже имеет доступ к курсу, отметка new=false указывает на существующее назначение.

Authorizations:

BearerToken

Request Body schema: multipart/form-data

userIds required	Array of integers
required	Array of objects

Responses

Response samples

200
422
500

Content type

application/json

{"success": true,
"results": [{"userId": 1,
"courseId": 1,
"result": true,
"new": true
}
]
}

Отозвать курс у пользователя

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

Authorizations:

BearerToken

Request Body schema: multipart/form-data

userIds required	Array of integers
required	Array of objects

Responses

Response samples

200
422
500

Content type

application/json

{"success": true,
"results": 1
}

Users.Import

Импорт пользователей

Назначение: массовая загрузка пользователей из Excel. Процесс: load-template -> preview -> load (commit) -> get-import-progress.

Скачать шаблон импорта (XLSX)

Возвращает Excel-шаблон для массового импорта пользователей. Содержит необходимые колонки (username, email, password, department, position и др.) с примерами и подсказками. Используйте этот файл как основу для подготовки данных к импорту.

Authorizations:

BearerToken

Responses

Response samples

500

Content type

application/json

{"success": false,
"errors": {"server": ["Internal server error. Try again later"
]
}
}

Предварительный просмотр импорта

Валидирует загруженный файл и показывает предварительный просмотр данных, которые будут импортированы. Помогает обнаружить ошибки в формате или содержимом перед фактическим импортом. Возвращает список строк и ошибок валидации для каждой записи.

Authorizations:

BearerToken

Request Body schema: multipart/form-data

fileImport	string <binary>
updateMode	boolean

Responses

Response samples

200
500

Content type

application/json

{"success": true,
"meta": {"total": 150,
"page": 1,
"per_page": 20
},
"data": {"preview": { }
}
}

Запустить импорт

Запускает асинхронный процесс импорта пользователей из загруженного файла. Возвращает jobId для отслеживания прогресса и reportKey для получения результатов. Используйте метод get-import-progress для мониторинга и получения финального отчета.

Authorizations:

BearerToken

Request Body schema: multipart/form-data

fileImport	string <binary>
updateMode	boolean

Responses

Response samples

200
422
500

Content type

application/json

{"success": true,
"meta": {"total": 150,
"page": 1,
"per_page": 20
},
"data": {"jobId": 1,
"reportKey": "example"
}
}

Получить прогресс импорта

Возвращает текущий статус и прогресс импорта пользователей. Параметр id должен содержать reportKey из ответа метода load. По завершении импорта включает финальный отчет с результатами (количество успешно импортированных, ошибки, предупреждения).

Authorizations:

BearerToken

query Parameters

id

required

string

Report Key из метода load

Responses

Response samples

200
404

Content type

application/json

{"success": true,
"meta": {"total": 150,
"page": 1,
"per_page": 20
},
"data": {"progress": 1,
"report": { }
}
}

История импортов

Возвращает список всех выполненных импортов пользователей с пагинацией. Каждый отчет содержит информацию о дате импорта, количестве обработанных записей, количестве ошибок и результатах. Используйте метод downloadUserImportReport для получения детального отчета в формате Excel.

Authorizations:

BearerToken

query Parameters

page	integer >= 1 Default: 1 Example: page=1 Номер страницы для пагинации
per_page	integer [ 1 .. 100 ] Default: 20 Example: per_page=50 Количество элементов на странице (максимум 100)
type	integer Фильтр по типу отчета

Responses

Response samples

200
422
500

Content type

application/json

{"success": true,
"meta": {"total": 150,
"page": 1,
"per_page": 20
},
"data": {"pagination": {"total": 150,
"page": 1,
"per_page": 20
},
"items": [{"id": 456,
"status": "completed",
"total": 100,
"processed": 98,
"errors": 2,
"created_at": 1705316400,
"updated_at": 1705319400
}
]
}
}

Скачать отчет об импорте

Возвращает детальный отчет об импорте в формате Excel. Отчет содержит информацию о каждой обработанной строке (успех/ошибка), данные пользователя и результат обработки. Используйте ID отчета из метода listUserImportReports.

Authorizations:

BearerToken

query Parameters

id

required

integer

ID отчета об импорте

Responses

Response samples

500

Content type

application/json

{"success": false,
"errors": {"server": ["Internal server error. Try again later"
]
}
}

Users.Fields

Кастомные поля

Назначение: работа с дополнительными атрибутами профиля (UserFieldKey).

Получить список кастомных полей

Возвращает конфигурацию дополнительных полей профиля пользователя.

Authorizations:

BearerToken

Responses

Response samples

200
401

Content type

application/json

{"success": true,
"items": [{"id": 1,
"name": "John Doe",
"title": "Advanced Python",
"type": 1
}
]
}

Groups.Structure

Структура и иерархия групп

Назначение: выстроить иерархию корпоративных групп с поддержкой вложенности, фильтрации и синхронизации с продуктами/ролями. Ключевые особенности:

Родительские связи, проверка циклов, фильтры по статусу/group type и PaginationMeta.
Используются схемы Group, GroupListItem и стандартные ответы на ошибки. Пример Use case: интегратор CRM подстраивает дерево отделов: получает групповой каталог, создаёт новый подраздел с POST /group/group/create, затем проверяет структуру через /group/group/view.

Получить список групп

Возвращает список групп (без пагинации). Поддерживаются фильтры по id, parent_id, строке поиска и флагу showDefault (0/1). Сортировка задаётся параметром sort (например, sort=updated_at или sort=-updated_at).

Authorizations:

BearerToken

query Parameters

id	integer >= 1 Example: id=12 ID группы
parent_id	integer >= 1 Example: parent_id=10 ID родительской группы; если не указан — выводятся все корневые
search	string <= 255 characters Example: search=Sales Поиск по названию или описанию группы
sort	string Default: "-updated_at" Enum: "id" "-id" "search" "-search" "updated_at" "-updated_at" "userCount" "-userCount" Example: sort=-updated_at Поле сортировки (префикс `-` для убывания)
showDefault	integer Default: 0 Enum: 0 1 Показывать системные группы (guest/authorized)

Responses

Response samples

200
422
500

Content type

application/json

{"success": true,
"data": {"items": [{"id": 1,
"name": "IT Department",
"comment": "Разработка и поддержка IT систем",
"hierarchyPathString": "IT Department",
"userCount": 25,
"type": 2,
"image": "https://s3.reezonly.com/groups/it-dept.jpg",
"created_at": 1692979543,
"updated_at": 1692979543
},
{"id": 2,
"name": "Development Team",
"comment": "Frontend и backend разработка",
"hierarchyPathString": "IT Department / Development Team",
"userCount": 15,
"type": 2,
"parent_id": 1,
"image": null,
"created_at": 1692983410,
"updated_at": 1692983410
}
]
}
}

Получить детальную информацию о группе

Возвращает полную информацию о группе.

Authorizations:

BearerToken

query Parameters

id

required

integer >= 1

Example: id=1

ID группы

Responses

Response samples

200
401
403
500

Content type

application/json

{"success": true,
"data": {"item": {"id": 1,
"name": "IT Department",
"comment": "Разработка и поддержка IT систем",
"hierarchyPathString": "IT Department",
"userCount": 25,
"type": 2,
"image": "https://s3.reezonly.com/groups/it-dept.jpg",
"parent_id": null,
"created_at": 1692979543,
"updated_at": 1692979543,
"users": [{"id": 101,
"username": "john.doe",
"email": "john.doe@company.com",
"role": "admin",
"created_at": "2023-08-25T14:20:00Z"
},
{"id": 102,
"username": "jane.smith",
"email": "jane.smith@company.com",
"role": "editor",
"created_at": "2023-08-25T14:25:00Z"
}
],
"children": [{"id": 2,
"name": "Development Team",
"userCount": 15,
"hierarchyPathString": "IT Department / Development Team"
}
]
},
"rules": [ ]
}
}

Создать новую группу

Создает новую группу пользователей с поддержкой иерархии. Автоматически валидирует структуру иерархии, предотвращая циклические зависимости. Поддерживает загрузку изображения группы и опциональное добавление пользователей.

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

Проверка уникальности названия в рамках родительской группы
Валидация иерархии (предотвращение циклов)
Автоматическое построение иерархического пути
Загрузка изображения в S3 хранилище
Логирование действия в ActionLog

Authorizations:

BearerToken

Request Body schema: multipart/form-data
required

name required	string [ 2 .. 255 ] characters Название группы (обязательное поле)
comment	string <= 512 characters Описание группы (опционально)
parent_id	integer or null >= 1 ID родительской группы: `null` для корневой группы ID существующей группы для дочерней
user_ids	Array of integers <= 100 items [ items >= 1 ] Пользователи для добавления в группу
image_upload	string <binary> Файл изображения группы (через multipart/form-data)

Responses

Request samples

Payload

Content type

multipart/form-data

Example

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

{
  "name": "Support"
}

Response samples

200
422
500

Content type

application/json

{"success": true,
"data": {"group_id": 25
}
}

Обновить информацию о группе

Обновляет базовую информацию о группе: название, описание, родительскую группу. При изменении parent_id автоматически перестраивается иерархический путь для всех дочерних групп.

Важно: Изменение родительской группы затрагивает всю ветку дочерних групп.

Authorizations:

BearerToken

query Parameters

id

required

integer >= 1

Example: id=12

ID группы для обновления

Request Body schema: multipart/form-data
required

name required	string [ 2 .. 255 ] characters Название группы (обязательное поле)
comment	string <= 512 characters Описание группы (опционально)
parent_id	integer or null >= 1 ID родительской группы: `null` для корневой группы ID существующей группы для дочерней
user_ids	Array of integers <= 100 items [ items >= 1 ] Пользователи для добавления в группу
image_upload	string <binary> Файл изображения группы (через multipart/form-data)

Responses

Request samples

Payload

Content type

multipart/form-data

Example

Переименование группы

{
  "name": "Sales / Enterprise"
}

Response samples

200
404
422
500

Content type

application/json

{"success": true,
"data": {"group_id": 10
}
}

Удалить группу

Удаляет группу и все связанные данные:

Связи пользователей с группой
Правила доступа группы
Логирование действия

Важно: Нельзя удалить группу, у которой есть дочерние группы. Сначала нужно удалить или переместить все дочерние группы.

Authorizations:

BearerToken

query Parameters

id

required

integer >= 1

ID группы для удаления

Responses

Response samples

200
422
500

Content type

application/json

{"success": true
}

Массовое удаление групп

Удаляет несколько групп за один запрос. Каждая группа проверяется на отсутствие дочерних групп перед удалением.

Authorizations:

BearerToken

Request Body schema: multipart/form-data
required

groupIds

required

Array of integers <= 50 items [ items >= 1 ]

Массив ID групп для удаления (максимум 50)

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "groupIds": [
    10,
    11,
    12
  ]
}

Response samples

200
403
422
500

Content type

application/json

{"success": true
}

Получить список групп для справочника

Возвращает плоский список групп; иерархия собирается на клиенте при необходимости.

Authorizations:

BearerToken

query Parameters

showDefault

integer

Default: 0

Enum: 0 1

Показать системные группы (гостевые/авторизованные)

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"items": [{"id": 1,
"name": "Root"
},
{"id": 2,
"name": "Sales",
"parent_id": 1
},
{"id": 3,
"name": "Marketing"
}
]
}

Запустить экспорт структуры групп

Создаёт задачу экспорта групп по указанным фильтрам. Возвращает идентификатор экспорта и ссылку для скачивания после формирования.

Назначение: выгрузка дерева групп для сверки с внешней HR/CRM и последующего импорта/миграции.

Пример Use case: HR переносит сотрудников между группами, обновляет курсы через assign-courses, а затем скачивает актуальный экспорт структуры, чтобы сверить дерево отделов с HRM.

Authorizations:

BearerToken

Request Body schema: application/json
optional

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

Example

Экспорт в XLSX без пользователей

{"format": "xlsx",
"include_users": false
}

Response samples

200
403
500

Content type

application/json

{"success": true,
"data": {"export_id": 102,
"download_url": "https://space.example.com/export/102.xlsx"
}
}

Скачать сформированный экспорт групп

Возвращает файл экспорта (XLSX/CSV) по идентификатору задачи экспорта. Используется после получения уведомления о готовности экспорта или поллинга статуса.

Authorizations:

BearerToken

query Parameters

id

required

integer >= 1

ID задания экспорта

Responses

Response samples

200
404
500

Content type

application/octet-stream

UEsDBBQACAgI...

Groups.Members

Управление участниками групп

Назначение: массово добавлять/удалять пользователей и назначать курсы для групп на стороне интеграции. Ключевые особенности: простые payload’ы (user_id, course_ids, списки ids[]), поддержка экспорта, assign-courses для курсов, DELETE /multiple-delete. Пример Use case: HR переносит 50 сотрудников между группами, одновременно обновляя назначенные курсы через POST /group/group/assign-courses, а затем скачивает экспорт структуры (/group/group/export).

Добавить пользователей в группы

Добавляет пользователей в одну или несколько групп. Поддерживает пакетную обработку до 100 пользователей. Проверяет дубликаты и автоматически пропускает уже добавленных пользователей.

Authorizations:

BearerToken

Request Body schema: multipart/form-data
required

groupIds required	Array of integers [ 1 .. 10 ] items [ items >= 1 ] ID групп для операции
userIds required	Array of integers [ 1 .. 100 ] items [ items >= 1 ] ID пользователей для добавления/удаления
role	string Enum: "superadmin" "admin" "editor" "curator" "student" Роль пользователя в группе (опционально, используется при добавлении)

Responses

Response samples

200
404
422
500

Content type

application/json

{"success": true,
"meta": {"total": 150,
"page": 1,
"per_page": 20
}
}

Удалить пользователей из групп

Удаляет пользователей из указанных групп. Автоматически обрабатывает ситуации, когда пользователя нет в группе.

Authorizations:

BearerToken

Request Body schema: multipart/form-data
required

groupIds required	Array of integers [ 1 .. 10 ] items [ items >= 1 ] ID групп для операции
userIds required	Array of integers [ 1 .. 100 ] items [ items >= 1 ] ID пользователей для добавления/удаления
role	string Enum: "superadmin" "admin" "editor" "curator" "student" Роль пользователя в группе (опционально, используется при добавлении)

Responses

Response samples

200
403
422
500

Content type

application/json

{"success": true,
"meta": {"total": 150,
"page": 1,
"per_page": 20
}
}

Назначить курсы всем участникам группы

Назначает указанные курсы всем текущим участникам группы. Операция выполняется асинхронно через очередь для больших групп.

Authorizations:

BearerToken

Request Body schema: multipart/form-data
required

group_id required	integer >= 1 ID группы, для которой назначаются курсы
course_ids required	Array of integers [ 1 .. 50 ] items [ items >= 1 ] Идентификаторы курсов для назначения

Responses

Response samples

200
403
422
500

Content type

application/json

{"success": true
}

Certificates.Templates

Управление шаблонами для генерации PDF сертификатов: внешний вид, расположение элементов и переменные для подстановки данных (read-only).

Получить список шаблонов сертификатов

Возвращает все доступные шаблоны для генерации сертификатов

Authorizations:

BearerToken

query Parameters

page	integer >= 1 Default: 1 Example: page=1 Номер страницы для пагинации
per_page	integer [ 1 .. 100 ] Default: 20 Example: per_page=50 Количество элементов на странице (максимум 100)
active_only	boolean Default: true Показать только активные шаблоны

Responses

Response samples

200
403
422
500

Content type

application/json

{"success": true,
"data": {"pagination": {"total": 2,
"page": 1,
"per_page": 20
},
"items": [{"id": 1,
"name": "Default Blue",
"description": "Базовый синий шаблон",
"preview_url": "https://cdn.space/templates/1/preview.png",
"active": true,
"created_at": 1727772000,
"updated_at": 1730419200
},
{"id": 2,
"name": "Gold Award",
"description": "Золотой шаблон для VIP выпусков",
"preview_url": "https://cdn.space/templates/2/preview.png",
"active": true,
"created_at": 1728115200,
"updated_at": 1730534400
}
]
}
}

Получить детальную информацию о шаблоне сертификата

Возвращает полную информацию о шаблоне включая переменные и предпросмотр

Authorizations:

BearerToken

query Parameters

id

required

integer >= 1

Example: id=42

Идентификатор ресурса

Responses

Response samples

200
401
403
500

Content type

application/json

{"success": true,
"data": {"id": 2,
"name": "Gold Award",
"description": "Золотой шаблон для VIP выпусков",
"template_html": "<html>...шаблон...</html>",
"variables": [{"name": "username",
"type": "string",
"description": "Имя студента",
"required": true
},
{"name": "course_title",
"type": "string",
"required": true
}
],
"preview_url": "https://cdn.space/templates/2/preview.png",
"active": true
}
}

Certificates.Issued

Управление выданными сертификатами, их статусами и верификацией.

Получить список выданных сертификатов

Возвращает список выданных сертификатов с фильтрацией

Authorizations:

BearerToken

query Parameters

page	integer >= 1 Default: 1 Example: page=1 Номер страницы для пагинации
per_page	integer [ 1 .. 100 ] Default: 20 Example: per_page=50 Количество элементов на странице (максимум 100)
sort	string Example: sort=-created_at Сортировка результатов (например, -created_at для обратной сортировки)
search	string Поиск по сертификатам
course_id	integer >= 1 Фильтр по ID курса
user_id	integer >= 1 Фильтр по ID пользователя

Responses

Response samples

200
403
422
500

Content type

application/json

{"success": true,
"data": {"pagination": {"total": 2,
"page": 1,
"per_page": 20
},
"items": [{"id": 45,
"number": "CERT-2024-001",
"created_at": 1727772000,
"course": {"id": 456,
"alias": "onboarding-2024",
"title": "Онбординг",
"type_id": 1,
"picture_thumbnail": "https://cdn.space/courses/456/thumb.png"
},
"user": {"id": 123,
"username": "Иван Иванов",
"email": "ivan@example.com"
},
"file": "https://s3.space/certificates/2024/cert-45.pdf"
},
{"id": 46,
"number": "CERT-2024-002",
"created_at": 1728115200,
"course": {"id": 480,
"alias": "sales-master-2024",
"title": "Продажи B2B",
"type_id": 2,
"picture_thumbnail": "https://cdn.space/courses/480/thumb.png"
},
"user": {"id": 140,
"username": "Мария Петрова",
"email": "maria@example.com"
},
"file": "https://s3.space/certificates/2024/cert-46.pdf"
}
]
}
}

Получить информацию о выданном сертификате

Возвращает детальную информацию о конкретном выданном сертификате

Authorizations:

BearerToken

query Parameters

id

required

integer >= 1

Example: id=42

Идентификатор ресурса

Responses

Response samples

200
401
403
500

Content type

application/json

{"success": true,
"data": {"id": 45,
"number": "CERT-2024-001",
"created_at": 1727772000,
"user": {"id": 123,
"username": "Иван Иванов",
"email": "ivan@example.com"
},
"course": {"id": 456,
"alias": "onboarding-2024",
"title": "Онбординг",
"type_id": 1,
"picture_thumbnail": "https://cdn.space/courses/456/thumb.png"
},
"file": "https://s3.space/certificates/2024/cert-45.pdf",
"fields": [{"key": "student_name",
"value": "Иван Иванов"
},
{"key": "course_title",
"value": "Онбординг"
}
],
"template": {"id": 2,
"name": "Gold Award",
"hide_for_student": false,
"file": "https://s3.space/templates/2/template.pdf",
"type": {"id": 1,
"name": "Course completion"
}
}
}
}

Выдать сертификат

Выдает новый сертификат пользователю за прохождение курса

Authorizations:

BearerToken

Request Body schema: application/json
required

user_id required	integer >= 1 ID пользователя
course_id required	integer >= 1 ID курса
template_id required	integer >= 1 ID шаблона сертификата
issue_date	string <date> Дата выдачи (по умолчанию текущая)
expires_at	string <date> Дата истечения (необязательно)
custom_data	object Дополнительные данные для шаблона

Responses

Request samples

Payload

Content type

application/json

{"user_id": 123,
"course_id": 456,
"template_id": 2,
"issue_date": "2024-01-15",
"expires_at": "2025-01-15",
"custom_data": {"username": "Иван Иванов",
"course_title": "Онбординг"
}
}

Response samples

200
422
500

Content type

application/json

{"success": true,
"message": "Certificate created"
}

Скачать PDF сертификата

Возвращает PDF файл сертификата для скачивания

Authorizations:

BearerToken

query Parameters

id

required

integer >= 1

Example: id=42

Идентификатор ресурса

Responses

Response samples

200
404
500

Content type

application/pdf

UEsDBBQACAgI...

Сформировать ZIP с сертификатами

Запускает генерацию ZIP-архива сертификатов по фильтрам (search, course_id, user_id, пагинация, сортировка). Одновременно может быть только одна активная задача на ключ.

Назначение: массовая выгрузка сертификатов для передачи внешним системам или печати.

Пример Use case: администратор выбирает курс и диапазон пользователей, запускает экспорт и получает ссылку на архив.

Authorizations:

BearerToken

Request Body schema: application/json
optional

search	string
course_id	integer >= 1
user_id	integer >= 1
page	integer >= 1 Default: 1
per-page	integer [ 1 .. 500 ] Default: 50
sort	string

Responses

Request samples

Payload

Content type

application/json

{"course_id": 456,
"page": 1,
"per-page": 100,
"sort": "-issued_at"
}

Response samples

200
422
500

Content type

application/json

{"success": true,
"message": "Commit job queued",
"data": {"filePath": "https://space.example.com/uploads/certificates/zip/certificates-2025-02-11.zip"
}
}

Certificates.Lookups

Справочники и системные настройки, связанные с сертификатами.

Список курсов для выдачи сертификатов

Возвращает курсы (id, title, type) для выбора course_id при выдаче сертификатов.

Authorizations:

BearerToken

query Parameters

page	integer >= 1 Default: 1 Example: page=1 Номер страницы для пагинации
per_page	integer [ 1 .. 100 ] Default: 20 Example: per_page=50 Количество элементов на странице (максимум 100)
sort	string Example: sort=-created_at Сортировка результатов (например, -created_at для обратной сортировки)
title	string Поиск по названию курса

Responses

Response samples

200
403
422
500

Content type

application/json

{"success": true,
"data": {"pagination": {"total": 2,
"page": 1,
"per_page": 20
},
"items": [{"id": 12,
"title": "Онбординг",
"type": "course"
},
{"id": 18,
"title": "Менторская программа",
"type": "program"
}
]
}
}

Список пользователей для выдачи сертификатов

Возвращает пользователей (id, username, email) для выбора user_id при выдаче сертификатов.

Authorizations:

BearerToken

query Parameters

page	integer >= 1 Default: 1 Example: page=1 Номер страницы для пагинации
per_page	integer [ 1 .. 100 ] Default: 20 Example: per_page=50 Количество элементов на странице (максимум 100)
search	string Поиск по имени/email
courseIds	Array of integers Массив ID продуктов/курсов
groupIds	Array of integers Массив ID групп
inAllGroups	boolean Требовать принадлежность ко всем указанным группам
progressFrom	integer Минимальный прогресс
progressTo	integer Максимальный прогресс
documentExists	integer Enum: 0 1 Фильтр по наличию документа

Responses

Response samples

200
403
422
500

Content type

application/json

{"success": true,
"data": {"pagination": {"total": 2,
"page": 1,
"per_page": 20
},
"items": [{"id": 101,
"username": "Иван Иванов",
"email": "ivan@example.com"
},
{"id": 102,
"username": "Мария Петрова",
"email": "maria@example.com"
}
]
}
}

Справочник типов сертификатов

Возвращает список типов сертификатов для подстановки в запросах выдачи.

Authorizations:

BearerToken

Responses

Response samples

200
403
500

Content type

application/json

{"success": true,
"data": {"items": [{"id": 1,
"name": "Course completion",
"description": "Выдаётся за прохождение курса"
},
{"id": 2,
"name": "Exam",
"description": "Выдаётся за сдачу экзамена"
}
]
}
}

Список переменных сертификатов

Возвращает доступные переменные для шаблонов сертификатов (ключ, имя, обязательность).

Authorizations:

BearerToken

query Parameters

list_id	integer ID списка переменных
name	string Фильтр по имени переменной

Responses

Response samples

200
403
422
500

Content type

application/json

{"success": true,
"data": {"items": [{"id": 5,
"key": "username",
"name": "Имя пользователя",
"description": "Отображается на сертификате",
"required": true
},
{"id": 6,
"key": "course_title",
"name": "Название курса",
"required": true
}
]
}
}

Наборы переменных сертификатов

Возвращает значения переменных (variable_id, key, value) для подстановки в шаблоны.

Authorizations:

BearerToken

Responses

Response samples

200
403
422
500

Content type

application/json

{"success": true,
"data": {"items": [{"variable_id": 5,
"key": "username",
"value": "Иван Иванов"
},
{"variable_id": 6,
"key": "course_title",
"value": "Онбординг"
}
]
}
}

Courses

Курсы и обучающие продукты (read-only). Назначение: отдать актуальные метаданные курсов и продуктов для витрин/CRM/маркетинга. Ключевые особенности: постраничная выдача (/course/course/index), структура и уроки, атрибуты активности (students_count, enabled, status, picture, lms_id). Пример: внешняя CMS запрашивает /course/course/index, показывает карточки, затем /course/course/view для программы и уроков.

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

Возвращает список доступных курсов с базовой информацией (только чтение)

Authorizations:

BearerToken

query Parameters

page	integer >= 1 Default: 1 Example: page=1 Номер страницы для пагинации
per_page	integer [ 1 .. 100 ] Default: 20 Example: per_page=50 Количество элементов на странице (максимум 100)
title	string Поиск по названию курса
type	integer Тип курса (см. Course::TYPE_*)
enabled	string Фильтр по признаку доступности
sort	string Поле сортировки
status	string Статус курса
type_id	integer ID типа (product id)

Responses

Response samples

200
403
422
500

Content type

application/json

{"success": true,
"data": {"pagination": {"total": 2,
"page": 1,
"per_page": 20
},
"items": [{"id": 101,
"title": "Онбординг",
"description": "Базовый курс для новых сотрудников",
"status": "active",
"price": 0,
"duration": "2h",
"category": {"id": 5,
"name": "Корпоративное обучение"
},
"thumbnail_url": "https://cdn.space/courses/101.png",
"lms_id": 501,
"student_count": 240
},
{"id": 102,
"title": "Продажи B2B",
"description": "Практикум по продажам",
"status": "active",
"price": 1990,
"duration": "6h",
"category": {"id": 6,
"name": "Продажи"
},
"thumbnail_url": "https://cdn.space/courses/102.png",
"lms_id": 502,
"student_count": 120
}
]
}
}

Получить детальную информацию о курсе

Возвращает полную информацию о курсе включая программу обучения (только чтение)

Authorizations:

BearerToken

query Parameters

id

required

integer >= 1

Example: id=42

Идентификатор ресурса

Responses

Response samples

200
404
500

Content type

application/json

{"success": true,
"data": {"item": {"id": 101,
"title": "Онбординг",
"description": "Базовый курс для новых сотрудников",
"status": "active",
"price": 0,
"duration": "2h",
"level": "beginner",
"category": {"id": 5,
"name": "Корпоративное обучение"
},
"instructor": {"id": 77,
"name": "Анна Смирнова",
"avatar_url": "https://cdn.space/instructors/77.png"
},
"thumbnail_url": "https://cdn.space/courses/101.png",
"lms_id": 501,
"syllabus": [{"id": 1,
"title": "Введение",
"description": "Как работать в системе",
"duration": "10m",
"order": 1
}
],
"requirements": ["Корпоративная почта"
],
"outcomes": ["Понимание процессов компании"
],
"student_count": 240,
"rating": 4.8,
"reviews_count": 56,
"created_at": "2024-01-10T09:00:00Z",
"updated_at": "2024-11-02T11:00:00Z"
}
}
}

Pages

Страницы и контент сайта (read-only). Назначение: раскрыть структуру публичных/закрытых страниц для внешних CMS. Ключевые особенности: список типов (/dictionary/dictionary/page-types), выдача pages, поля enabled, SEO-метаданные, alias, category. Пример: внешняя система берёт меню, вызывает /dictionary/dictionary/pages, сортирует по типу, обновляет ссылки без доступа к внутренней CMS.

Получить список типов страниц

Справочник типов страниц сайта и продуктов (read-only): landing, blog, help, legal и другие.

Назначение: дать фронтам и внешним CMS нормализованные типы для фильтров и группировки страниц/лендингов.

Ключевые особенности: стабильные коды типов, совместимость с /dictionary/dictionary/pages, можно кешировать на клиенте.

Пример Use case: SPA-витрина запрашивает типы, строит фильтры и подсветку меню по категориям страниц.

Authorizations:

BearerToken

query Parameters

type	string Фильтр по типу страницы

Responses

Response samples

200
400

Content type

application/json

{"success": true,
"data": {"items": [{"id": 3,
"name": "landing"
},
{"id": 4,
"name": "blog"
}
]
}
}

Получить справочник страниц

Доступные страницы сайта (лендинги, продуктовые страницы) с базовыми метаданными (read-only): title, alias, type, enabled, SEO-атрибуты.

Назначение: раскрыть структуру публичных и закрытых страниц, чтобы внешние CMS могли собирать меню и лендинги без доступа в админку.

Ключевые особенности: фильтрация по типу (используйте /dictionary/dictionary/page-types), статус enabled, поля alias и category для навигации.

Пример Use case: внешняя система заимствует SPA-меню, вызывает /dictionary/dictionary/pages, сортирует по типу и обновляет ссылки на новом сайте без внутреннего CMS.

Authorizations:

BearerToken

Responses

Response samples

200
400

Content type

application/json

{"success": true,
"data": {"items": [{"id": 12,
"alias": "product-page-42",
"title": "Курс \"Data Science\"",
"description": "Лендинг продукта Data Science",
"enabled": true,
"type": "product-page"
},
{"id": 18,
"alias": "help-center",
"title": "Центр помощи",
"description": "Справочные статьи",
"enabled": true,
"type": "help"
}
]
}
}

Integration Reports

Отчеты для интеграционных систем

Генерация данных «Сводного» отчёта в JSON для BI/дашбордов без генерации файлов.

Сводный отчёт (JSON)

JSON-эквивалент XLSX «Сводный» отчёта с фильтрами по продуктам, группам, прогрессу и полям профиля.

Назначение: отдать тот же набор колонок, что в XLSX «Сводный», но в JSON для BI/дашбордов без генерации файлов.

Пример Use case: BI-интеграция запрашивает данные по конкретным продуктам и отделам, строит графики прогресса и статусов оплат без скачивания XLSX.

Authorizations:

BearerToken

Request Body schema: application/json
optional

product	Array of integers
group	Array of integers
user_ids	Array of integers
progress_from	integer [ 0 .. 100 ] Default: 0
progress_to	integer [ 0 .. 100 ] Default: 100
	object Фильтры по полям профиля (username, email, phone, department, position)
page	integer >= 1 Default: 1
per-page	integer [ 1 .. 1000 ] Default: 200
sort	string Default: "-date_added" Enum: "-date_added" "date_added" "-progress" "progress"

Responses

Request samples

Payload

Content type

application/json

{"product": [59,
62
],
"group": [14
],
"progress_from": 50,
"progress_to": 85,
"page": 1,
"per-page": 200,
"sort": "-date_added"
}

Response samples

200
400
403

Content type

application/json

{"success": true,
"data": {"filters": {"product": [59,
62
],
"progress_from": 50,
"progress_to": 85,
"fields": {"email": ["ya.ru"
]
}
},
"items": [{"product": {"id": 59,
"title": "Цифровые коммуникации"
},
"status": {"code": 4,
"name": "Оплачен"
},
"amount": 60000,
"date_added_at": {"unix": 1730399460,
"iso": "2024-10-31T13:11:00+03:00"
},
"last_activity_at": {"unix": null,
"iso": null
},
"registered_at": {"unix": 1698747060,
"iso": "2023-10-31T13:11:00+03:00"
},
"progress_percent": 72,
"user": {"id": 215,
"name": "Георгий",
"email": "poooga@ya.ru",
"phone": "+79999999952",
"department": "Отдел разработки",
"position": "Директор по продукту"
}
}
],
"pagination": {"page": 1,
"per_page": 200,
"total": 8,
"total_pages": 1
}
}
}

Reezonly Space Platform API (1.0.0)

Что можно делать через API

Аутентификация

Базовый URL

Users.Operations

Базовые операции с пользователями

Получить список пользователей

Authorizations:

query Parameters

Responses

Response samples

Получить список администраторов

Authorizations:

query Parameters

Responses

Response samples

Получить профиль пользователя

Authorizations:

query Parameters

Responses

Response samples

Создать пользователя

Authorizations:

Request Body schema: multipart/form-datarequired

Responses

Response samples

Обновить пользователя

Authorizations:

query Parameters

Request Body schema: multipart/form-datarequired

Responses

Response samples

Удалить пользователя(ей)

Authorizations:

query Parameters

Responses

Response samples

Справочник статусов

Authorizations:

Responses

Response samples

Users.Courses

Управление курсами пользователя

Назначить курс пользователю

Authorizations:

Request Body schema: multipart/form-data

Responses

Response samples

Отозвать курс у пользователя

Authorizations:

Request Body schema: multipart/form-data

Responses

Response samples

Users.Import

Импорт пользователей

Скачать шаблон импорта (XLSX)

Authorizations:

Responses

Response samples

Предварительный просмотр импорта

Authorizations:

Request Body schema: multipart/form-data

Responses

Response samples

Запустить импорт

Authorizations:

Request Body schema: multipart/form-data

Responses

Response samples

Получить прогресс импорта

Authorizations:

query Parameters

Responses

Response samples

История импортов

Authorizations:

query Parameters

Responses

Response samples

Скачать отчет об импорте

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: multipart/form-data
required

Request Body schema: application/json
optional

Request Body schema: multipart/form-data
required