1. 应用功能模块注册
按要求提供相关接口，可以实现对应用模块在工作台的定制！目前支持两种模式实现对应用功能模块注册，应用自主注册和云助手拉取。
1.1. 应用自主注册
通过请求云助手接口实现对应用的功能模块的增删改查
1.1.1. 获取access_token
获取access_token，请参考这里
1.1.2. 注册功能模块
接口地址
https://www.fdccloud.com/api/open1/regist-app-module?access_token=ACCESS_TOKEN
请求方式
POST
请求参数(json)
{
"module_id":"20001",
"module_name":"百度",
"module_memo":"百度",
"open_url":"http://www.baidu.com",
"icon_url":"http://www.xxx.com/1.jpg",
"sort":10,
"disable":0
}
参数说明
| 参数 | 描述 |
|---|---|
| module_id | 必填,应用的模块id，应用内要唯一 |
| module_name | 必填,模块的名称 |
| module_memo | 选填,模块的简介 |
| open_url | 必填,模块的跳转链接 |
| icon_url | 必填,模块图标 |
| sort | 选填,模块在应用内的排序，从小到大的顺序排序 |
| disable | 选填,是否被禁用，1-禁用 0-启用，默认为 0 |
返回结果
成功：
{
"errcode": 0,//0代表成功
"errmsg": "ok"
}
失败：
{
"errcode": 错误code，非0,
"errmsg": "错误信息"
}
1.1.3. 更新功能模块信息
接口地址
https://www.fdccloud.com/api/open1/update-app-module?access_token=ACCESS_TOKEN
请求方式
POST
请求参数(json)
{
"module_id":"20001",
"module_name":"百度",
"module_memo":"百度",
"open_url":"http://www.baidu.com",
"icon_url":"http://www.xxx.com/1.jpg",
"sort":10,
"disable":0
}
参数说明
| 参数 | 描述 |
|---|---|
| module_id | 必填,应用的模块id，应用内要唯一 |
| module_name | 选填,模块的名称 |
| module_memo | 选填,模块的简介 |
| open_url | 选填,模块的跳转链接 |
| icon_url | 选填,模块图标 |
| sort | 选填,模块在应用内的排序，从小到大的顺序排序 |
| disable | 选填,是否被禁用，1-禁用 0-启用，默认为 0 |
module_name,module_memo,open_url,icon_url,sort,disable有一个是必填的
返回结果
成功：
{
"errcode": 0,//0代表成功
"errmsg": "ok"
}
失败：
{
"errcode": 错误code，非0,
"errmsg": "错误信息"
}
1.1.4. 删除功能模块
接口地址
https://www.fdccloud.com/api/open1/delete-app-module?access_token=ACCESS_TOKEN
请求方式
POST
请求参数
{
"module_id":"20001"
}
参数说明
| 参数 | 描述 |
|---|---|
| module_id | 必填,应用的模块id，应用内要唯一 |
返回结果
成功：
{
"errcode": 0,//0代表成功
"errmsg": "ok"
}
失败：
{
"errcode": 错误code，非0,
"errmsg": "错误信息"
}
1.1.5. 获取应用所有的功能模块
接口地址
https://www.fdccloud.com/api/open1/get-app-module?access_token=ACCESS_TOKEN
请求方式
GET
返回结果
成功：
{
"errcode": 0,//0代表成功
"errmsg": "ok"
"data":[
{
"id":1,
"app_code":"10000",//云助手中的应用code
"module_id":"1",//模块id
"module_name":"企业通知",
"module_memo":"企业通知",
"open_url":"模块跳转地址",
"icon_url":"模块图标地址",
"sort":"模块排序",
"disable":"0",//是否被禁用
"create_time":"创建时间",
"update_time":"更新时间",
"custom_module_name":"客户自定义模块名字",
"custom_icon_url":"客户自定义模块图片链接地址"
}
]
}
失败：
{
"errcode": 错误code，非0,
"errmsg": "错误信息"
"data":""
}
1.2. 云助手主动拉取
需要第三方提供接口，当用户在使用应用模块相关功能的时候，会触发云助手异步请求第三方提供的获取模块接口，来实现全量拉取应用模块的功能， 所以因为异步请求，所以第一次请求可能会看不到最新数据，第二次则会正常.
1.2.1. 第三方接口要求
- 获取应用的功能模块支持分页，防止大数据请求超时
- 全量拉取，每次请求的时候需要把当前把当前租户可用的功能模块分页的模式下返回
- 获取功能模块的接口地址提供给云助手负责人-梅义
1.2.2. 请求方式
POST
1.2.3. 请求参数
| 参数 | 描述 |
|---|---|
| corpid | 异构系统的企业代码，唯一 |
| app_code | 应用的app_code,异构系统的应用code |
| page_index | 请求的分页id，第一页传1，后面依次递增,建议每次请求返回数据不要太多，否则可能导致请求超时，建议每次100条数据 |
| signature | 服务商接口签名,salt=party,查看生成规则 |
| timestamp | 时间戳 |
| channel_id | 渠道ID |
1.2.4. 返回的结果
成功：
{
"success":"1",
"data":[
{
"module_id":"10001", //必填
"module_name":"我审批的",//必填
"module_memo"："我审批的流程",
"open_url":"模块跳转链接",//必填
"icon_url":"模块的图标地址",//必填
"sort":"模块的排序",
"disable":"模块是否禁用 1-禁用 0-可用，默认为0",
}],
"is_finish":true|false//是否完成，当返回结果是true，云助手不会增加页数来继续请求，
如果是false且data中有值，则会继续请求最大请求次数100，默认为true
}
失败：
{
"success":"0",
"data":"",
"errmsg":"失败的信息，方便排查问题"
}
2. 用户可见的应用模块
需要第三方提供此接口，用于用户查看自己可以使用的功能模块，这个是用户在查看自己功能模块的时候主动调用此接口!
2.1. 请求方式
POST
2.2. 请求参数
| 参数 | 描述 |
|---|---|
| user_code | 异构系统的用户的账号 如:zhangsan |
| corpid | 异构系统的企业代码 如: mysoft |
| app_code | 应用的app_code,异构系统的应用code |
| signature | 服务商接口签名,salt=party,查看生成规则 |
| timestamp | 时间戳 |
| channel_id | 渠道ID |
2.3. 返回结果
成功：
{
"success":"1",
"data":["1","2"] //用户可见的模块id
}
失败：
{
"success":"0",
"data":"",
"errmsg":"失败的信息，方便排查问题"
}