Skip to Content
Справочник APIОсновные эндпоинты API

Основные эндпоинты API

Проверка статуса API

Получение информации о статусе API и версиях.

Запрос

GET /api/status

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. API ключ

Ответ

{ "message": "Welcome to Flute CMS API", "flute_version": "1.0.0", "api_version": "1.0.0" }
ПолеТипОписание
messagestringПриветственное сообщение
flute_versionstringВерсия Flute CMS
api_versionstringВерсия API

Коды ответов

КодОписание
200Успешный запрос
401Неверный API ключ или отсутствует
403Недостаточно прав для выполнения запроса

Получение разрешений текущего API ключа

Получение списка разрешений для текущего API ключа.

Запрос

GET /api/permissions

Заголовки

НазваниеТипОписание
X-API-KeystringОбязательный. API ключ

Ответ

{ "permissions": [ { "id": 1, "name": "admin.users", "description": "Управление пользователями" }, { "id": 2, "name": "admin.roles", "description": "Управление ролями" } ] }
ПолеТипОписание
permissionsarrayМассив разрешений
idintegerID разрешения
namestringИмя разрешения
descriptionstringОписание разрешения

Коды ответов

КодОписание
200Успешный запрос
401Неверный API ключ или отсутствует