API登录认证

1. 概述

第三方应用调用 FineBI Cloud 接口时,可以通过 API Token 完成认证,无需交互式登录。

注意:请妥善保管 API Token,避免泄露造成企业数据泄露。

本功能仅面向企业版用户开放。非企业版用户需先升级版本

2. 获取 Authorization

获取 Authorization 的用户需为当前企业的超级管理员。

可通过以下方式获取:

1)企业创建者登录 FineBI Cloud。

2)按 F12 打开浏览器开发者工具,在「Network」中查看已登录业务请求的请求头。

3)复制该请求的完整 Authorization 值。

4)通过「Authorization>Bearer Token」输入 Authorization 值即可。

3. 获取accessKeyId与accessKeySecret

接口信息

说明

接口作用

获取 accessKeyId 与 accessKeySecret

接口路径

/api/v1/corp/get/apitoken

请求方式

GET

请求头

Authorization,值为第 2 节获取的内容

响应实例

请求示例

https://bi.finecloud.com/decision/api/v1/corp/get/apitoken

响应成功

{

"success": true,

"code": "200",

"message": "success",

"data": {

"accessKeyId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",

"accessKeySecret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

},

"errorCode": null,

"detailErrorMsg": null,

"errorMsg": null

}

截图示意

请妥善保存返回的 accessKeyId 和 accessKeySecret,用于申请临时令牌。

4. 申请临时令牌

接口信息

说明

接口作用

申请临时令牌

接口路径

/api/v1/corp/oauth/token

请求方式

GET

查询参数如下。

参数

说明

是否必填

accessKeyId

第 3 节获取的 accessKeyId

是

accessKeySecret

第 3 节获取的 accessKeySecret

是

响应实例

请求示例

https://bi.finecloud.com/decision/api/v1/corp/oauth/token?accessKeyId=${your_access_key_id}&accessKeySecret=${your_access_key_secret}

响应成功

{

"success":true,

"code":"200",

"message":"success",

"data":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",

"errorCode":null,

"detailErrorMsg":null,

"errorMsg":null

}

截图示意

成功响应中,data 为临时令牌:

1)10 秒内只允许获取 1 次临时令牌。

2)临时令牌有效期为 1 小时,失效后需重新获取。

3)获取令牌时错误次数过多,会被限制获取。

5. 访问 API 接口

访问业务接口时,在请求头中设置 Authorization,值为第 4 节获取的临时令牌。

从 A 企业获取的令牌只能访问 A 企业的接口,不能用于访问同一用户所在的其他企业。

咨询
扫码领取100+零代码资料简道云官方微信号400-111-0890
图标在线咨询
立即体验