腾讯云 BI(Business Intelligence,BI)提供从数据接入到模型分析、数据可视化呈现、数据门户搭建、应用协同、权限管理等全流程 BI 能力,有效整合企业多业务数据源,帮助经营者快速获取决策数据依据。系统采用敏捷自助式设计,使用者仅需通过简单拖拽即可完成复杂的报表输出过程,通过和企业微信、公众号的打通,快速实现报表的分享、推送、评论互动等协作场景。
本章节介绍的腾讯云 BI API 接口均为 API 3.0 接口。
您可以调用 API 对腾讯云 BI 进行操作,例如:创建强鉴权 token、创建用户、修改用户信息、创建项目、修改项目信息等。
腾讯云 BI 支持的所有接口信息,请参见 API 概览。
术语表
腾讯云 BI API 接口的常见术语请参见下表:
术语 | 描述 |
---|---|
嵌出 | 嵌出是指整个数据看板或者数据看板下的某个页面,点击嵌出按钮,使用指定的 URL 将报表嵌入到其他的系统,方便访问。 |
强鉴权嵌出 | 在嵌出操作时,开启嵌出校验,必须使用 API 接口生成带有效期的 token,然后拼接完整的 URL,进行访问。 |
弱鉴权嵌出 | 在嵌出操作时,关闭嵌出校验,自动生成带 token 的嵌出链接,无需使用 API 接口。 |
API 快速入门
您可以使用 API Explorer 工具在线调用 API。
本文以 创建强鉴权 token 为例,通过 API Explorer 工具调用 API 接口的步骤如下:
- 进入 API Explorer 工具页面。更多 API Explorer 工具使用信息,请参见 使用 API Explorer。
- 调用 CreateEmbedToken 接口, 根据接口文档中的入参说明,结合自身业务需求,填好入参,接口会返回强鉴权 token。
- 结合看板页面的嵌出配置弹框,拼接好嵌出 URL, 然后放入浏览器地址栏,可以正常访问报表页面。
至此,您已完成一个强鉴权嵌出的 token 创建,并进行了强鉴权嵌出的访问。