文档

智能问数安全增强的嵌入分析方案

更新时间:

本文将为您介绍如何使用智能问数Ticket嵌入方案免登嵌入到第三方系统,以及如何通过票据管理有效防止链接被恶意分享数据泄露的问题。本文适用于专业版。

背景信息

Quick BI 全新推出了安全增强的嵌入分析方案,简称Ticket智能问数嵌入方案,当使用 Quick BI 专业版时,可实现链接、访问、问数等多场景一站式安全管控,帮助您低成本与企业业务系统集成,高效构建自有品牌特色的数据产品。

注意事项

需要先开通智能问数模块。

重要

智能问数属于增值模块,当前在邀请测试阶段,如需试用,请您联系商务运营同学。

步骤1:开通智能问数嵌入

您可以使用以下方式开通智能问数嵌入:

  1. 在 Quick BI 产品首页,按照下图指引,进入组织管理-智能问数-嵌入管理页面。image

  2. 勾选开启嵌入模块

    勾选后,在嵌入配置对话框,进行以下配置。

    image

    配置项

    说明

    Ticket链接

    您可以手动输入Ticket链接或者单击快捷生成,生成Ticket。

    image

    在生成Ticket的界面,您可以设置绑定用户有效时长访问次数

    • 绑定用户:嵌入的报表权限支持选择绑定某一个用户的权限。

    • 有效时长:默认过期时间为240分钟,支持自定义传失效时间,最大不超过240分钟。

    • 访问次数:若输入1,表示生成的链接仅支持被访问1次。默认为1,最大支持输入9999次。

    获取嵌入代码

    支持生成URL链接Iframe代码

  3. 单击复制

步骤2:通过API接口生成AccessTicket票据

  1. 调用create4Copilot接口生成报表嵌入需要使用的Ticket。

    生成accessTicket的各项参数说明如下:

    参数名称

    类型

    描述

    CopilotId

    String

    开通嵌入的智能问数模块 ID。

    TicketNum

    Integer

    Ticket的票据数量。

    • 默认值为1。

    • 建议值为1。

    • 最大值为99999。

    每次使用票据访问后,Ticket的票据数量减1。

    UserId

    String

    Quick BI 的UserId,非您的阿里云账号ID。

    您可以调用 QueryUserInfoByAccount 接口,获取 UserId。UserId 样例为fe67f61a35a94b7da1a34ba174a7****。

    说明

    UserIdAccountName只填一个即可,不填时默认开启问数嵌入的Owner。

    AccountName

    String

    用户的账号名称。

    • 如果用户是阿里云主账号wangwu,格式为[主账号],例如wangwu。

    • 如果用户是RAM账号zhangsan**@aliyun.cn,格式为[主账号:子账号],例如wangwu:zhangsan**。

    说明

    UserIdAccountName只填一个即可,不填时默认开启问数嵌入的Owner。

    AccountType

    Integer

    用户的账号类型。

    • 1:阿里云账号

    • 3:Quick BI 自建账号

    • 4:钉钉

    • 5:RAM子账号

    • 9:企业微信

    • 10:飞书

    说明

    AccountName不为空时,则AccountType也不能为空。

    ExpireTime

    Integer

    过期时间。

    • 单位:分钟

    • 默认值:240

    说明

    链接防分享控制:TicketNum 的取值建议为1,表示生成的第三方嵌入链接仅被访问一次。

  2. 生成AccessTicket。

    示例代码请参见生成智能小Q嵌入Ticket

    返回结果示例如下:

    { 
      "requestId" : "7D784AB0-5B77-077E-B628-E782B58D3898", 
      "result" : "fd138bcb-****-4fde-b413-81bcee59bdb6",
      "success" : true
    }
    说明

    result 即为此次 API 调用生成的 AccessTicket,AccessTicket 为fd138bcb-****-4fde-b413-81bcee59bdb6。

步骤3:拼接免登URL

  • 拼接流程及示例见下表:

    流程

    智能问数模块示例

    1.获取 Quick BI 域名

    bi.aliyun.com

    2.获取智能问数嵌入 URL

    token3rd/copilot

    3.获取智能问数模块 ID

    dd0****83f

    4.获取 AccessTicket

    fd138bcb-****-4fde-b413-81bcee59bdb6

  • 拼接格式及智能问数URL如下:

    仪表板的拼接格式为:https://<Quick BI域名>/<智能问数嵌入 URL>?copilotId=<智能问数模块 ID>&accessTicket=<AccessTicket>

    则生成的URL为:https://bi.aliyun.com/token3rd/dashboard/view/pc.htm?copilotId=dd0****83f&accessTicket=fd138bcb-****-4fde-b413-81bcee59bdb6

    访问该URL效果如下:image