Перейти к содержанию

permissions

В этой статье

(описание будет добавлено при генерации)

Методы API

| Метод | Действие | Описание | |-------|----------|----------|| add | назначение прав | Назначает указанные функции ролям или наоборот. Поддерживает пакетное назначение через массивы. || delete | удаление прав | Удаляет связь между ролью и функцией. || func_add | добавление функции | Создает новую функцию в системе. || func_delete | удаление функции | Удаляет функцию из системы. || func_list | список функций | Возвращает список всех доступных функций. || func_show | просмотр функции | Возвращает детальную информацию о конкретной функции. || func_update | обновление функции | Обновляет параметры существующей функции. || list | получение списка разрешений | Возвращает список разрешений (связок ролей и функций) с возможностью фильтрации по конкретной роли или функции. || role_add | создание роли | Создает новую роль с заданным именем. || role_delete | удаление роли | Удаляет существующую роль. || role_list | получение списка ролей | Возвращает список всех доступных ролей. || role_show | просмотр роли | Возвращает детальную информацию о конкретной роли. || role_update | обновление роли | Обновляет параметры существующей роли. |

permissions/add

Назначает указанные функции ролям или наоборот. Поддерживает пакетное назначение через массивы.

HTTP-метод: POST

Параметры:

action ✅ string Идентификатор метода: add
token ✅ string Токен авторизации
role_name ✅ array<string> Список имен ролей. Принимает несколько значений: role_name[]=admin&role_name[]=user или через запятую.
func_name ✅ array<string> Список имен функций. Принимает несколько значений: func_name[]=read&func_name[]=write или через запятую.

Пример запроса

curl -s "https://invapi.hostkey.ru/permissions.php" -X POST \
--data "action=add" \
--data "token=HOSTKEY_TOKEN" \
--data "role_name[]=admin" \
--data "role_name[]=user" \
--data "func_name[]=read" \
--data "func_name[]=write"
Пример успешного ответа 
{
"result": "OK",
"action": "add",
"permissions": [
{
"role_name": "admin",
"func_name": "manage_users"
}
]
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide role_name and func_name"
}

permissions/delete

Удаляет связь между ролью и функцией.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: delete
token ✅ string Токен авторизации
role_name ✅ string Название роли для удаления прав
func_name ✅ string Название функции для удаления прав

Пример запроса

curl -s "https://invapi.hostkey.ru/permissions.php" -X POST \
--data "action=delete" \
--data "token=HOSTKEY_TOKEN" \
--data "role_name=VALUE" \
--data "func_name=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "delete",
"permissions": [
{
"role_name": "admin",
"func_name": "manage_users"
}
]
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide role_name and func_name"
}

permissions/func_add

Создает новую функцию в системе.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: func_add
token ✅ string Токен авторизации
params[name] ✅ string Имя новой функции. Допустимые значения: буквенно-цифровые символы, /, _.

Пример запроса

curl -s "https://invapi.hostkey.ru/permissions.php" -X POST \
--data "action=func_add" \
--data "token=HOSTKEY_TOKEN" \
--data "params[name]=new_function"
Пример успешного ответа 
{
"result": "OK",
"action": "func_add",
"functions": [
{
"name": "new_function"
}
]
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide entity data"
}

permissions/func_delete

Удаляет функцию из системы.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: func_delete
token ✅ string Токен авторизации
func_name ✅ string Имя функции для удаления из системы

Пример запроса

curl -s "https://invapi.hostkey.ru/permissions.php" -X POST \
--data "action=func_delete" \
--data "token=HOSTKEY_TOKEN" \
--data "func_name=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "func_delete",
"functions": [
{
"name": "deleted_function"
}
]
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide func_name"
}

permissions/func_list

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

HTTP-метод: GET

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: func_list
token ✅ string Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/permissions.php" -X GET \
--data "action=func_list" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа 
{
"result": "OK",
"action": "func_list",
"functions": [
{
"name": "system.read"
},
{
"name": "system.write"
}
]
}
Примеры ошибок 
{
"code": -1,
"message": "Error fetching functions"
}

permissions/func_show

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

HTTP-метод: GET

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: func_show
token ✅ string Токен авторизации
func_name ✅ string Имя функции для получения детальной информации

Пример запроса

curl -s "https://invapi.hostkey.ru/permissions.php" -X GET \
--data "action=func_show" \
--data "token=HOSTKEY_TOKEN" \
--data "func_name=system.read"
Пример успешного ответа 
{
"result": "OK",
"action": "func_show",
"functions": {
"name": "system.read",
"description": "Description of function"
},
"permissions": null
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide func_name"
}

permissions/func_update

Обновляет параметры существующей функции.

HTTP-метод: POST

Параметры:

action ✅ string Идентификатор метода: func_update
token ✅ string Токен авторизации
func_name ✅ string Имя функции для обновления.
params[name] ❌ string Новое имя функции. Допустимые значения: буквенно-цифровые символы, /, _.

Пример запроса

curl -s "https://invapi.hostkey.ru/permissions.php" -X POST \
--data "action=func_update" \
--data "token=HOSTKEY_TOKEN" \
--data "func_name=VALUE" \
--data "params[name]=NEW_NAME"
Пример успешного ответа 
{
"result": "OK",
"action": "func_update",
"functions": {
"name": "updated_function"
}
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide func_name"
}

permissions/list

Возвращает список разрешений (связок ролей и функций) с возможностью фильтрации по конкретной роли или функции.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: list
token ✅ string Токен авторизации
role_name ❌ string Название роли для фильтрации списка разрешений
func_name ❌ string Название функции для фильтрации списка разрешений

Пример запроса

curl -s "https://invapi.hostkey.ru/permissions.php" -X POST \
--data "action=list" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа 
{
"result": "OK",
"action": "list",
"permissions": [
{
"role_name": "admin",
"func_name": "user_delete"
},
{
"role_name": "manager",
"func_name": "user_edit"
}
]
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide role_name or func_name"
}

permissions/role_add

Создает новую роль с заданным именем.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: role_add
token ✅ string Токен авторизации
params[name] ✅ string Имя новой роли. Допустимые значения: [a-z0-9/_]+.

Пример запроса

curl -s "https://invapi.hostkey.ru/permissions.php" -X POST \
--data "action=role_add" \
--data "token=HOSTKEY_TOKEN" \
--data "params[name]=new_role"
Пример успешного ответа 
{
"result": "OK",
"action": "role_add",
"roles": [
{
"name": "new_role"
}
]
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide entity data"
}

permissions/role_delete

Удаляет существующую роль.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: role_delete
token ✅ string Токен авторизации
role_name ✅ string Название роли для удаления

Пример запроса

curl -s "https://invapi.hostkey.ru/permissions.php" -X POST \
--data "action=role_delete" \
--data "token=HOSTKEY_TOKEN" \
--data "role_name=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "role_delete",
"roles": [
{
"name": "deleted_role"
}
]
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide role_name"
}

permissions/role_list

Возвращает список всех доступных ролей.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: role_list
token ✅ string Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/permissions.php" -X POST \
--data "action=role_list" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа 
{
"result": "OK",
"action": "role_list",
"roles": [
{
"name": "admin"
},
{
"name": "user"
}
]
}
Примеры ошибок 
{
"code": -1,
"message": "Error fetching roles"
}

permissions/role_show

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

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: role_show
token ✅ string Токен авторизации
role_name ✅ string Имя роли для получения детальной информации

Пример запроса

curl -s "https://invapi.hostkey.ru/permissions.php" -X POST \
--data "action=role_show" \
--data "token=HOSTKEY_TOKEN" \
--data "role_name=admin"
Пример успешного ответа 
{
"result": "OK",
"action": "role_show",
"roles": {
"name": "admin",
"permissions": []
}
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide role_name"
}

permissions/role_update

Обновляет параметры существующей роли.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: role_update
token ✅ string Токен авторизации
role_name ✅ string Название роли для обновления
params ❌ array<string> Массив параметров для обновления данных роли

Пример запроса

curl -s "https://invapi.hostkey.ru/permissions.php" -X POST \
--data "action=role_update" \
--data "token=HOSTKEY_TOKEN" \
--data "role_name=VALUE" \
--data "params[]=val1" \
--data "params[]=val2"
Пример успешного ответа 
{
"result": "OK",
"action": "role_update",
"roles": {
"name": "updated_role"
}
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide role_name"
}
question_mark
Я могу вам чем-то помочь?
question_mark
ИИ Помощник ×