变更记录
产品版本 | 更新内容 | 更新日期 |
V5.0.001 | 初始版本 | 2022年6月 |
V6.0.1 | 支持增强型Token认证,合并AccessToken认证和JWT认证策略 | 2023年10月 |
1 简介
1.1 功能介绍
统一管理需要调用苍穹OpenAPI的外部应用;支持多种认证方式,如accessToken认证、摘要认证、JWT认证、基本认证、签名认证(V5.0.011版本及以上),是外部系统登录金蝶云苍穹的身份凭证;同时支持API接口授权、IP白名单等功能。
1.2 应用场景
外部系统注册第三方应用,获取身份凭证并调用苍穹OpenAPI。
1.3 操作路径
路径:【开放服务云】→【OpenAPI】→【安全策略】→【第三方应用】
1.4 字段/按钮说明
字段说明
字段名称 | 详细解释 |
基本信息 |
|
系统编码 | 第三方应用编码,即appId/client_id |
系统名称 | 第三方应用名称 |
创建人 | 创建人
|
是否启用 | 第三方应用状态,启用/禁用 |
系统最后启用时间 | 第三方应用的启用时间 |
系统最后停止时间 | 第三方应用的停机时间 |
访问策略 - AccessToken认证 |
|
AccessToken认证密钥 | 第三方应用的认证密钥,即appSecret/client_secret |
增强型Token认证 | 启用后,将采用更加标准的Token认证规范,只需一步即可获取access_token和JWT,并禁用login.do的获取方式。默认限制token获取频率,避免频繁创建会话,影响系统稳定性。 |
启用JWT认证 | JWT认证开关,默认为否 |
JWT签名策略 | SHA256/RSA |
访问策略 - 摘要认证 |
|
签名策略 | SHA256 |
认证密钥 | 摘要加密认证key |
访问策略 - 基本认证 |
|
基本认证用户 | 登录时的代理用户(基本认证和签名认证必须维护) |
Secret Key | 基本认证密钥,系统自动生成
|
显示密钥
| 是否在界面显示密钥 |
是否有效 | 密钥有效开关,是/否 |
访问策略 - IP黑白名单
|
|
允许全部IP访问 | IP黑白名单开关,默认打开 |
IP策略
| 黑名单/白名单 |
起始IP
| 起始IP |
结束IP | 结束IP |
访问策略 - 加密策略
|
|
加密策略 | 接口数据加密策略,支持不加密/AES/SM4 |
加密全部API | API加密开关,默认为否 |
API编码 | 当为API加密开关为否时,通过F7批量选择后在列表展示的API服务编码 |
API名称
| API名称 |
URL | 请求地址 |
业务对象 | API所属业务对象 |
所属应用
| API所属应用 |
API授权 |
|
授权全部API | API授权开关,默认为否 |
API编码 | 当为API授权开关为否时,通过F7批量选择后在列表展示的API服务编码 |
API名称
| API名称 |
URL | 请求地址 |
业务对象 | API所属业务对象 |
所属应用
| API所属应用 |
按钮说明
按钮名称 | 详细解释 |
保存 | 保存第三方应用信息 |
退出 | 退出当前界面 |
2 主要操作
2.1 新增第三方应用
打开第三方应用列表界面,管理所有第三方应用信息。
点击“新增”按钮,打开第三方应用新增界面,用户可以在访问策略中选择需要的策略:
认证策略:
常用认证方式为AccessToken认证,用户需要手工维护符合安全规范的AccessToken认证密钥;
使用安全性更高的摘要认证密钥,可点击字段后的“刷新”按钮,系统自动生成认证密钥;
签名认证 对请求入参和出参都进行加签的的认证方式,有效保护接口数据正确性,防篡改;
基本认证(主要用于接口回调场景),在选择代理用户后,系统自动生成认证签名。
加密策略:
访问控制策略:
2.2 API授权
新增的第三方应用还需要设置可访问的接口范围,支持选择系统中的所有OpenAPI。当完全信任对方系统时,可以打开“授权全部API”开关。
3 更多资讯
关于认证方式的更多信息,请关注金蝶云苍穹OpenAPI开发认证指南。