应用安装卸载接口
安装聚合应用
使用场景: 安装聚合应用到指定机构。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 仅租户管理员 |
机构凭证 | 未支持 |
请求方式: POST(HTTPS)
请求地址: https://jz.hasmartedu.com/oapi/app/install_integrate_app?access_token=ACCESS_TOKEN
请求包体:
{
"appid":70000,
"corpid":1000850
}
参数说明 :
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用租户管理员的user_token |
appid | 是 | 需要安装的应用id,(服务商后台应用详情的SuiteId) |
corpid | 是 | 机构id |
返回结果:
{
"errcode":0,
"errmsg":"ok"
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码,0为正常 |
errmsg | 对返回码的文本描述内容 |
卸载聚合应用
使用场景: 卸载某机构的聚合应用。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 仅租户管理员 |
机构凭证 | 未支持 |
请求方式: POST(HTTPS)
请求地址: https://jz.hasmartedu.com/oapi/app/uninstall_integrate_app?access_token=ACCESS_TOKEN
请求包体:
{
"appid":70000,
"corpid":1000850
}
参数说明 :
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用租户管理员的user_token |
appid | 是 | 需要卸载的应用id (服务商后台应用详情的SuiteId) |
corpid | 是 | 机构id |
返回结果:
{
"errcode":0,
"errmsg":"ok"
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码,0为正常 |
errmsg | 对返回码的文本描述内容 |
批量安装子应用
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 未支持 | |
机构凭证 | 支持 |
使用场景: 批量安装子应用到指定机构
请求方式: POST(HTTPS)
请求地址: https://jz.hasmartedu.com/oapi/app/batch_install_sub_apps?access_token=CORP_ACCESS_TOKEN
请求包体:
{
"appids":[70000,70001],
"sub_corpid":102548
}
参数说明 :
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用聚合应用在该机构的corptoken |
appids | 是 | 需要安装的应用id列表 (服务商后台应用详情的SuiteId) |
sub_corpid | 否 | 下级机构id(上级单位管理员可使用) |
返回结果:
{
"errcode":0,
"errmsg":"ok",
"installed_appids":[70000],
"installed_res":[
{"app_id":70000,"code":1,"message":"应用安装成功"},
{"app_id":10001,"code":2,"message":"安装失败的报错信息"}
]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码,0为正常 |
errmsg | 对返回码的文本描述内容 |
installed_appids | 安装成功的应用id列表 |
installed_res | 安装详情列表 |
installed_res.app_id | 应用id |
installed_res.code | code 1-成功 2-失败 |
installed_res.message | 详细信息 |
批量卸载子应用
使用场景: 批量卸载子应用
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 未支持 | |
机构凭证 | 支持 |
请求方式: POST(HTTPS)
请求地址: https://jz.hasmartedu.com/oapi/app/batch_uninstall_sub_apps?access_token=CORP_ACCESS_TOKEN
请求包体:
{
"appids":[70000,70001],
"sub_corpid":102548
}
参数说明 :
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用聚合应用在该机构的corptoken |
appids | 是 | 需要卸载的应用id列表 |
sub_corpid | 否 | 下级机构id(上级单位管理员可使用) |
返回结果:
{
"errcode":0,
"errmsg":"ok",
"uninstalled_appids":[70000],
"uninstalled_res":[
{"app_id":70000,"code":1,"message":"应用卸载成功"},
{"app_id":10001,"code":2,"message":"卸载失败的报错信息"}
]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码,0为正常 |
errmsg | 对返回码的文本描述内容 |
uninstalled_appids | 卸载成功的应用id列表 |
uninstalled_res | 卸载详情列表 |
uninstalled_res.app_id | 应用id |
uninstalled_res.code | code 1-成功 2-失败 |
uninstalled_res.message | 详细信息 |