如果您的 api 是需要进行认证的，如 AK/SK 鉴权，摘要签名认证等，那么可以在空间工作台左侧的「API 认证」页面中配置 API 认证。共支持包括 sugar openapi（sugar 中支持的 openapi）、百度云 API 网关、bos、阿里云 API 网关、如流、钉钉、企业微信、飞书、BML/EasyDL AK/SK 认证(私有云)、BML/EasyDL AK/SK 认证(公有云)、BML/EasyDL 的 Access Code 和自定义 API 换 token 在内的 12 种认证方式。

注：API 认证在私有部署版本默认开启，如不需要，可以通过环境变量 sugar_api_auth=0 来关闭。

配置 API 认证需要打开「API 认证权限」，可以在「用户管理」->「权限配置」中进行设置。

设置流程

1. 新增 API 认证。

2. 在新增 API 的弹窗中填写名称、api 认证类型，说明和认证需要的 AK、SK。这里以百度云 API 网关为例。

3. 如果类型选择了「自定义 API 换 token」，以配置 EasyDL 预测服务的 token 认证为例，调用 EasyDL 预测服务的 api 时，需要在 query 参数中传递 access_token 字段，所以 调用业务api时使用token字段的位置选择 query 参数，通过token调用业务api的token字段名填 access_token，通过token调用业务api的token字段值也是 access_token。token计算api填写 EasyDL 获取 access_token 的 api，一般需要传递 ak/sk 参数，按对应文档要求填写 ak/sk 的字段名和字段值。对于 EasyDL 预测服务来说除了 ak/sk，还需要 grant_type 字段，在 token计算API所需额外参数（除AK/SK）中添加即可。

4. 通过token调用业务api的token字段值：支持使用${TOKEN}值指代通过调用 token 计算 api 得到的 token 值，这样可以自由指定所传 token 的格式，如Bearer ${TOKEN}。

调用方式

在大屏和报表的图表使用 api 拉取方式获取数据时，可以开启API认证，在选择API认证的下拉框中选择我们刚刚创建的 API 认证既可。这里以百度云 API 网关为例。

如果 api 返回结果跟图表的数据格式要求不匹配，可以开启 API 高级配置，使用 api 转换器进行转换，详见API 高级配置。