Skip to Content
Справочник APIAPI разрешений

API разрешений

Эндпоинты для управления разрешениями в системе.

Получение списка разрешений

Получение полного списка разрешений.

Запрос

GET /api/permissions

Заголовки

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

Ответ

{ "permissions": [ { "id": 1, "name": "admin.users", "description": "Управление пользователями" }, { "id": 2, "name": "admin.roles", "description": "Управление ролями" }, { "id": 3, "name": "admin.pages", "description": "Управление страницами" } ] }

Поля ответа

ПолеТипОписание
permissionsarrayМассив разрешений
idintegerID разрешения
namestringИмя разрешения
descriptionstringОписание разрешения

Коды ответов

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

Получение данных разрешения

Получение детальной информации о конкретном разрешении.

Запрос

GET /api/permissions/{id}

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

НазваниеТипОписание
idintegerID разрешения

Заголовки

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

Ответ

{ "permission": { "id": 1, "name": "admin.users", "description": "Управление пользователями" } }

Поля ответа

ПолеТипОписание
permissionobjectОбъект разрешения
idintegerID разрешения
namestringИмя разрешения
descriptionstringОписание разрешения

Коды ответов

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

Создание разрешения

Создание нового разрешения в системе.

Запрос

POST /api/permissions

Заголовки

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

Тело запроса

{ "name": "admin.settings", "description": "Управление настройками системы" }

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

НазваниеТипОписание
namestringОбязательный. Имя разрешения
descriptionstringНеобязательный. Описание разрешения

Ответ

{ "message": "Permission created successfully", "permission": { "id": 4, "name": "admin.settings", "description": "Управление настройками системы" } }

Коды ответов

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

Обновление разрешения

Обновление данных существующего разрешения.

Запрос

PUT /api/permissions/{id}

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

НазваниеТипОписание
idintegerID разрешения

Заголовки

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

Тело запроса

{ "name": "admin.system-settings", "description": "Управление системными настройками" }

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

НазваниеТипОписание
namestringНеобязательный. Имя разрешения
descriptionstringНеобязательный. Описание разрешения

Ответ

{ "message": "Permission updated successfully", "permission": { "id": 4, "name": "admin.system-settings", "description": "Управление системными настройками" } }

Коды ответов

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

Удаление разрешения

Удаление разрешения из системы.

Запрос

DELETE /api/permissions/{id}

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

НазваниеТипОписание
idintegerID разрешения

Заголовки

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

Ответ

{ "message": "Permission deleted successfully" }

Коды ответов

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