Основные эндпоинты API
Проверка статуса API
Получение информации о статусе API и версиях.
Запрос
GET /api/status
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Ответ
{
"message": "Welcome to Flute CMS API",
"flute_version": "1.0.0",
"api_version": "1.0.0"
}
Поле | Тип | Описание |
---|---|---|
message | string | Приветственное сообщение |
flute_version | string | Версия Flute CMS |
api_version | string | Версия API |
Коды ответов
Код | Описание |
---|---|
200 | Успешный запрос |
401 | Неверный API ключ или отсутствует |
403 | Недостаточно прав для выполнения запроса |
Получение разрешений текущего API ключа
Получение списка разрешений для текущего API ключа.
Запрос
GET /api/permissions
Заголовки
Название | Тип | Описание |
---|---|---|
X-API-Key | string | Обязательный. API ключ |
Ответ
{
"permissions": [
{
"id": 1,
"name": "admin.users",
"description": "Управление пользователями"
},
{
"id": 2,
"name": "admin.roles",
"description": "Управление ролями"
}
]
}
Поле | Тип | Описание |
---|---|---|
permissions | array | Массив разрешений |
id | integer | ID разрешения |
name | string | Имя разрешения |
description | string | Описание разрешения |
Коды ответов
Код | Описание |
---|---|
200 | Успешный запрос |
401 | Неверный API ключ или отсутствует |