YesApi 接口文档

7801 权限分配

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

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

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

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

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
user_role字符串可选最大：20会员分组，小白的会员角色，user表示普通用户，admin表示管理员，同时支持自定义分组
assign_user字符串可选最大：32授权的用户，对应小白会员的UUID
menu_key字符串必须最大：255客户端软件应用的菜单项，可以是菜单、URL或者其他，用于程序判断
menu_title字符串可选最大：100菜单标题，用于备注或界面展示
menu_icon字符串可选最大：255菜单图标
menu_sort整型可选0菜单排序，值越小越靠前

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

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

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

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

# 示例4，在前面的基础上，同时设置菜单操作的菜单图标、标题和排序值，方便菜单列表显示
{你的接口域名}/?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"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作状态码，0成功，1已存在重复的权限，9插件表单未安装
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
data.id整型成功分配权限后的ID
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

7802 权限移除

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

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

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

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
user_role字符串可选最大：20会员分组，小白的会员角色，user表示普通用户，admin表示管理员，同时支持自定义分组
assign_user字符串可选最大：32授权的用户，对应小白会员的UUID
menu_key字符串必须最大：255客户端软件应用的菜单项，可以是菜单、URL或者其他，用于程序判断

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作状态码，0成功，9插件表单未安装
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

7803 获取用户权限列表

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

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

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

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
assign_user字符串可选最大：32授权的用户，对应小白会员的UUID

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
请求：
{你的接口域名}/?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"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作状态码，0成功，9插件表单未安装
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
data.items字符串权限列表
data.items[].menu_key字符串菜单项
data.items[].menu_title字符串菜单名称
data.items[].menu_icon字符串菜单图标
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

7804 用户权限检测

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

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

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

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
assign_user字符串可选最大：32授权的用户，对应小白会员的UUID
menu_key字符串必须最大：255客户端软件应用的菜单项，可以是菜单、URL或者其他，用于程序判断

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
请求：
{你的接口域名}/?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"
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作状态码，0成功，1没有权限，9插件表单未安装
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

特别注意：当前 hn216.api.okayapi.com 为临时接口测试域名！请先完成 绑定独立接口域名后 ，才能正式进行API调用。

由 果创云YesApi.cn 提供技术支持，4万+开发者都在用，累计API调用1,800,000＋万次