变更记录

产品版本更新内容更新日期
R202303.001初始版本2023年03月21日
R202403.001

1. 开放平台改名为OpenAPI,并迁移到开放服务云;

2. 第三方应用支持增强型Token认证,同时AccessToken认证策略和JWT认证策略合并成一个访问策略。

2024年02月29日
R202404.001API请求接入API网关,所有请求统一添加要求添加网关identity进行身份合法性识别;2024年04月11日


1 简介

   本文档适用于所有第三方应用调用金蝶AIOpenAPI。当外部系统调用金蝶AI苍穹OpenAPI时,金蝶AI会对每个API请求进行身份的校验,判断其请求的合法性,最后再响应该API请求。

   建议开发者在正式开发前该对金蝶AI的访问凭证机制有充分的了解。


   2024年04月11日:

   为提升租户环境稳定性,金蝶AI在R202403.001版本正式接入网关针对 API 的访问策略进行了升级调整,进一步提升访问安全及数据安全

   详见【2. 认证流程】。


2 认证流程

  1. 在开放平台创建第三方应用,录入第三方应用基本信息,保存并启用后就会生成一个appId/client_id(系统编码)x-acgw-identity(系统身份标识)

  2. 配置您在OpenAPI使用时需使用的访问策略;

  3. 基于访问策略,生成相关API请求时的认证鉴权信息;

  4. 客户端生成这个认证鉴权信息后,后续每次请求中,客户端把【x-acgw-identity】及【认证鉴权信息】放在请求Header中发送给服务器,服务器验证签名是否有效,如果有效那么认证就成功,可以返回客户端需要的数据。


3 认证方式

   金蝶AI目前共支持五种认证方式,分别是AccessToken 认证、摘要认证、JWT认证、基本认证和安全性最高的签名认证。其中最常用的是AccessToken认证,最方便的则是基本认证。不同的认证方式各有特点,用户可以根据具体需求,选择合适的认证方式。


   金蝶AI-R202404.001(金蝶AI苍穹V6.0)版本变化:

   1. 【新增】【强制】API请求需在请求头加入公共参数x-acgw-identity(从产品端内获取)

   2. 【新增】OpenAPI新增了增强型Token认证,支持通过接口获取、刷新、验证及失效access_token,建议新用户获取金蝶AI苍穹access_token时,统一使用增强型Token认证调用OpenAPI

   注:若金蝶AI苍穹版本低于6.0,获取access_token参考API认证方式-Accesstoken认证/JWT认证


1)系统路径:

【开放服务云】→【OpenAPI】→【第三方应用】。


2)认证方式选择

认证方式点击查看详情安全性便捷性
增强型Token认证★★★★★★★
AccessToken认证/JWT认证★★★★★★
摘要认证★★★★★★
基本认证★★★★★
签名认证★★★★★



4 注意事项

1)以上5种认证方式,用户可以根据实际需要选择,也可以同时使用;

2)将access_token放在header中传递,而不是在URL中,提升安全性;

3)令牌的获取是有限制的,每个令牌的有效期为 2 小时,请自行做好令牌的管理,在令牌快过期时(通过验证接口获取剩余过期时间比如1小时50分),可重新调用接口获取或调用刷新令牌接口延长有效期。

4)面向金蝶AI发起的API调用,必须携带x-acgw-identity参数;

5)在第三方应用详情页面点击更新身份标识后,历史x-acgw-identity将会立即失效,请谨慎操作,避免影响业务正常运行。

5 更多资讯

请关注开放平台新特性公告的最新特性

金蝶AIOpenAPI接口规范

OpenAPI - 增强型Token认证

OpenAPI - AccessToken认证/JWT认证

OpenAPI - 摘要认证

OpenAPI - 基本认证

OpenAPI - 签名认证