OpenAPI基本认证,是结合了HTTPS Basic Authentication 的一种认证方式,在通过基本认证登录系统并调用接口的过程中,需要在请求的URL参数或请求header中带上openApiSign凭证,形式如下: {host}?openApiSign=xxx,该凭证是由第三方应用、代理用户和当前数据中心ID组合并加密生成的base64编码,可以作为访问开放平台OpenAPI 的固定认证密钥。基本认证作为接口匿名访问的一种更安全和方便的替代方案,可以广泛应用于接口回调的场景。
注意:当第三方应用启用基本认证后,由于基本认证密钥是长期有效的,必须配合API授权来保证系统整体安全。
进入第三方应用,访问策略添加基本认证:

编辑基本认证策略,选择基本认证用户,点击确认后,并保存单据(务必点击保存,否则基本认证不生效)。

进行API授权,用户需对第三方应用进行 原厂服务包 或 租户自建API 进行访问授权后第三方应用才可正常访问相关API,授权操作是配置可访问的接口范围。
1. 服务授权:针对原厂标准API所组成的服务包进行授权,服务包有任何更新时可无感知实时更新权限;
2. 自建API授权:针对项目二开自建API进行授权;

自行组装已授权API的调用url,在请求URL后追加query参数,示例可见<三、接口调用示例>;
同时,OpenAPI也提供了快捷生成回调地址的方案,通过API详情中的回调地址配置:

注意:如若在生成回调地址前,未通过第三方应用进行服务授权或自建API授权,该回调地址的调用可能会出现<应用未订阅该API[网关]>的异常报错,故在生成回调地之前,请务必先进行授权操作!!!
请求头参数
传入参数 | 字段类型 | 是否必填 | 字段说明 |
x-acgw-Identity | string | 是 | 应用身份标识,第三方应用启用后自动生成 |
openApiSign | string | 是 | 基本认证凭证 |
URL:http://{{localhost}}/kapi/v2/kdtest/gl/gl_voucher/gl_voucher?billno=cugyi5&pageSize=10&pageno=1&openApiSign=Slh4bFF3Mnh0LXZLUE9fRUtzRnItc2JTblgyM0RtNk9RN2V5ODR2WU13QT06MTMzMTIwNDQ0NTk5NTc5NDQzbg==&x-acgw-Identity={第三方应用身份标识}
请求Header参数:
Content-Type=application/json
请求结果:
{
"data": {
"lastPage": true,
"pageNo": 1,
"pageSize": 10,
"rows": [
{
"id": "1393492185164283904",
"billno": "cugyi5",
"entries": [
{
"id": "1393492186380632064",
"assgrp": {
"id": "1393492186061865984",
"供应商": {
"name": "唐山金属材料有限公司",
"number": "SUP000001",
"id": "346159251409862656"
},
"文本弹性域": "其他"
}
}
]
}
],
"totalCount": 1
},
"errorCode": "0",
"message": "",
"status": true
}当金蝶AI苍穹与外围系统对接时,若存在某个接口回调场景,对方系统接口协议规定:访问路径需要为固定接口且不可以添加参数,或在接口访问路径中不允许有“?”,金蝶AI苍穹开放平台回调接口可使用如下格式:
http://{{localhost}}/$/openApiSign/xxx/billno/cugyi5/pageSize/10/pageno/1注意:URL中openApiSign必须在特殊符号“$”后,在其他URL参数前。