• OkayAPI Docs
  • Login
  • Try for free



YesApi 接口文档

7801 权限分配

接口路径(新):http://api.okayapi.com/api/App/Market_RightsAssign/Assign

接口路径(旧):http://api.okayapi.com/?s=App.Market_RightsAssign.Assign

接口描述: 对自己的软件应用进行权限分配,以下三种组合视为唯一的权限分配组:

  • 为用户分组和指定用户分配权限:user_role + assign_user + menu_key
  • 为用户分组分配权限:user_role + menu_key
  • 为指定用户分配权限:assign_user + menu_key
使用前请先安装用户权限分配插件

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
user_roleStringOptaionMAX: 20会员分组,小白的会员角色,user表示普通用户,admin表示管理员,同时支持自定义分组
assign_userStringOptaionMAX: 32授权的用户,对应小白会员的UUID
menu_keyStringRequiredMAX: 255客户端软件应用的菜单项,可以是菜单、URL或者其他,用于程序判断
menu_titleStringOptaionMAX: 100菜单标题,用于备注或界面展示
menu_iconStringOptaionMAX: 255菜单图标
menu_sortIntOptaion0菜单排序,值越小越靠前

API Usage Demo

HTTP
# 示例1,为用户分组和指定用户分配权限,如分配删除用户权限,请求:
{OKAYAPI_API_HOST}/?s=App.Market_RightsAssign.Assign&user_role=user&assign_user=FDF97454F265E3C5B90A14AA9B0C6B66&menu_key=remove_user&menu_sort=0&app_key={你的app_key}&sign={动态签名}

# 示例2,为用户分组分配权限,如分配删除用户权限(分配后属于该用户分组的都具有此权限),请求:
{OKAYAPI_API_HOST}/?s=App.Market_RightsAssign.Assign&user_role=user&menu_key=remove_user&menu_sort=0&app_key={你的app_key}&sign={动态签名}

# 示例3,为指定用户分配权限,分配后只有该用户拥有此权限,请求:
{OKAYAPI_API_HOST}/?s=App.Market_RightsAssign.Assign&assign_user=FDF97454F265E3C5B90A14AA9B0C6B66&menu_key=remove_user&menu_sort=0&app_key={你的app_key}&sign={动态签名}

# 示例4,在前面的基础上,同时设置菜单操作的菜单图标、标题和排序值,方便菜单列表显示
{OKAYAPI_API_HOST}/?s=App.Market_RightsAssign.Assign&assign_user=FDF97454F265E3C5B90A14AA9B0C6B66&menu_key=remove_user&menu_title=删除用户&menu_icon=icon-delete&menu_sort=10

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "id": 12
    },
    "msg": "小白开放接口:App.Market_RightsAssign.Assign"
}

API Response

KEYTypeDescription
err_codeInt操作状态码,0成功,1已存在重复的权限,9插件表单未安装
err_msgString错误提示信息,err_code非0时参考此提示信息
idInt成功分配权限后的ID

YesApi 接口文档

7802 权限移除

接口路径(新):http://api.okayapi.com/api/App/Market_RightsAssign/Remove

接口路径(旧):http://api.okayapi.com/?s=App.Market_RightsAssign.Remove

接口描述: 进行权限移除,删除已经分配的权限。使用前请先安装用户权限分配插件

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
user_roleStringOptaionMAX: 20会员分组,小白的会员角色,user表示普通用户,admin表示管理员,同时支持自定义分组
assign_userStringOptaionMAX: 32授权的用户,对应小白会员的UUID
menu_keyStringRequiredMAX: 255客户端软件应用的菜单项,可以是菜单、URL或者其他,用于程序判断

API Usage Demo

API Response

KEYTypeDescription
err_codeInt操作状态码,0成功,9插件表单未安装
err_msgString错误提示信息,err_code非0时参考此提示信息

YesApi 接口文档

7803 获取用户权限列表

接口路径(新):http://api.okayapi.com/api/App/Market_RightsAssign/GetUserRights

接口路径(旧):http://api.okayapi.com/?s=App.Market_RightsAssign.GetUserRights

接口描述: 获取单个用户权限列表,并根据菜单排序值从小到大返回。接口将会自动提取assign_user所在分组的全部权限。最多返回1000组。使用前请先安装用户权限分配插件

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
assign_userStringOptaionMAX: 32授权的用户,对应小白会员的UUID

API Usage Demo

HTTP
请求:
{OKAYAPI_API_HOST}/?s=App.Market_RightsAssign.GetUserRights&assign_user=FDF97454F265E3C5B90A14AA9B0C6B66&app_key={你的app_key}&sign={动态签名}

返回(最多1000组):
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "items": [
        {
            "menu_key": "add_user",
            "menu_title": "添加用户",
            "menu_icon": ""
        },
        {
            "menu_key": "remove_user",
            "menu_title": "删除用户",
            "menu_icon": "icon-delete"
        }
        ]
    },
    "msg": "小白开放接口:App.Market_RightsAssign.GetUserRights"
}

API Response

KEYTypeDescription
err_codeInt操作状态码,0成功,9插件表单未安装
err_msgString错误提示信息,err_code非0时参考此提示信息
itemsArray权限列表
items[].menu_keyString菜单项
items[].menu_titleString菜单名称
items[].menu_iconString菜单图标

YesApi 接口文档

7804 用户权限检测

接口路径(新):http://api.okayapi.com/api/App/Market_RightsAssign/Verify

接口路径(旧):http://api.okayapi.com/?s=App.Market_RightsAssign.Verify

接口描述: 检测单个用户的是否具备某项菜单权限。使用前请先安装用户权限分配插件

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
assign_userStringOptaionMAX: 32授权的用户,对应小白会员的UUID
menu_keyStringRequiredMAX: 255客户端软件应用的菜单项,可以是菜单、URL或者其他,用于程序判断

API Usage Demo

HTTP
请求:
{OKAYAPI_API_HOST}/?s=App.Market_RightsAssign.Verify&assign_user=FDF97454F265E3C5B90A14AA9B0C6B66&menu_key=remove_user&app_key={你的app_key}&sign={动态签名}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": ""
    },
    "msg": "小白开放接口:App.Market_RightsAssign.Verify"
}

API Response

KEYTypeDescription
err_codeInt操作状态码,0成功,1没有权限,9插件表单未安装
err_msgString错误提示信息,err_code非0时参考此提示信息

Power by OkayAPI.com Contact us (WA: okayapi OR Email: chanzonghuang@gmail.com).
Timezone: America/New_York Jul/01/2025 21:13:47