HTTP/HTTPS
请求协议
YesDev / WebAPI / 获取产品应用管理配置
获取产品应用管理配置
接口地址:http://test.www.yesdev.cn/api/platform.php?s=Platform.Apps_ProductSettings.GetProductSetttingsDetail
接口描述: 获取产品应用管理配置
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
app_key | 字符串 | 可选 | app_key,团队代码 | ||
sign | 字符串 | 可选 | - | 动态签名,签名算法请联系我们技术客服获取 | |
yesdev_product_key | 字符串 | 必须 | - | 最小:1 | YesDev产品KEY |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.detail | 对象 | 产品应用管理配置 |
data.detail.yesdev_product_status | 整型 | 状态,1开启0禁用 |
data.detail.visit_mode | 整型 | 可见范围,0全员1按角色2按员工 |
data.ops | 数组 | 菜单权限列表 |
data.ops[].id | 整型 | 菜单ID |
data.ops[].title | 字符串 | 菜单标题 |
data.ops[].path | 字符串 | 菜单路径 |
data.ops[].role_items | arry | 角色授权列表,其中 is_assigned表示是否授权,1是0否 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
app_key | 可选 | |
sign | 可选 | |
yesdev_product_key | 必须 |
客户端请求示例
{
"ret": 200,
"data": {
"detail": { // 应用详情
"id": 1,
"app_key": "gc",
"add_time": "2024-04-30 15:21:20",
"yesdev_product_key": "WORKBENCH",
"yesdev_product_title": "", // 预留,暂时用前端的配置
"yesdev_product_status": 0, // 状态,1开启0禁用
"visit_mode": 0, // 可见范围,0全员1按角色2按员工
"allow_role_id_list": [199, 101], // visit_mode=1时有意义;允许的角色ID 数组,没有时为空数组
"allow_staff_id_list": [] // visit_mode=2时有意义;允许指定的员工ID 数组,没有时为空数组
},
"ops": [
{
"id": 278,
"path": "/project",
"title": "项目模块",
"parent_id": 0,
"role_items": [
{
"role_id": 105,
"role_name": "普通成员(系统)",
"is_assigned": 0
},
{
"role_id": 199,
"role_name": "企业管理员(系统)",
"is_assigned": 0
},
{
"role_id": 1000,
"role_name": "测试",
"is_assigned": 0
}
]
}
// ... 很多组 ...
]
},
"msg": ""
}
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
410 | 权限不足 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-09-17 04:08:34 联系我们开通接入OpenAPI