1.1 Overview #

When embedding dashboards externally, authentication is performed via OpenAPI. The embedding party is responsible for applying for the OpenAPI token to achieve custom permission control, which also avoids the need for repeated logins when users click the dashboard to access the system.
Caution: Before using the interfaces described in this document, please first understand the invocation method. For details, see Invocation Method.

1.2 Solution introduction #

First, refer to the OpenAPI overview to apply for a clientID / secret, and use the clientID / secret to obtain a JWT token.

1.2.1 Frontend integration #

Embed into desktop page

// 在嵌入的iframe url上带上jwtToken；
// 注意OpenAPI鉴权路由前缀使用/bi-open/而不是/bi/；
// SaaS环境
<iframe src=`uri/bi/datawind-open/.......?a=b&jwtToken=${jwtToken}` />
// 私有化部署
<iframe src=`uri/bi-open/.......?a=b&jwtToken=${jwtToken}` />

Embed into mobile page

// 在移动端嵌入的iframe url上带上jwtToken；
// SaaS环境
<iframe src=`uri/bi/datawind-h5/.......?a=b&jwtToken=${jwtToken}` />
// 私有化部署
<iframe src=`uri/bi-h5/.......?a=b&jwtToken=${jwtToken}` />

1.2.2 Overall interaction sequence diagram #

1.3 Usage example #

1.3.1 Related terminology #

Embedding party: The platform that embeds the system's dashboard into its own platform for user access, using but not limited to iframe methods
Browsing user: The user entity who browses the embedding party's page and may view the embedded dashboard page
Intelligent Data Insight user: The user entity on the Intelligent Data Insight platform
System administrator: The system administrator of Intelligent Data Insight (with the highest site-wide permissions)

1.3.2 Case #

Requirement description
The embedding party needs to display the dashboard of the Intelligent Data Insight product on its own platform and independently control permission management (or not perform permission control). For example, the embedding party has a BI (Business Intelligence) display page, and the product dashboard is embedded in this page. When a browsing user accesses this display page, if the embedding party determines that the browsing user has access permission to this page, the dashboard on this page is displayed unconditionally, ignoring the actual permissions of the browsing user in the Intelligent Data Insight product (or the browsing user may not even exist on the Intelligent Data Insight platform).
Usage process
(1) The system administrator applies for a client ID / secret with the binding type set to "system"
(2) When a browsing user visits the embedding party, the embedding party applies for an Intelligent Data Insight system token and sets proxyUser to the Intelligent Data Insight system user corresponding to the current browsing user.

• Caution: The corresponding Smart Data Insights users do not need to have a one-to-one mapping with browsing users.
• Example 1: To display the product dashboard to personnel in a specific region, the embedding platform only needs to create a "virtual user" in the Smart Data Insights system corresponding to that region and grant the virtual user the appropriate permissions (such as resource access permissions, data row and column permissions, and more). The embedding party can set proxyUser to the corresponding virtual user based on different attributes of the browsing user (for example, different regions).
• Example 2: To display the embedded product dashboard unconditionally, meaning any browsing user accessing the embedding platform can view the embedded dashboard without restriction, proxyUser can be set to a user who has permission for the embedded dashboard (or a user with higher permissions).
  (3) Then embed the token in the product dashboard Iframe.
  (4) (This step is performed automatically by the product dashboard) The Smart Data Insights system dashboard Iframe sends a query to the product backend. The Smart Data Insights system backend parses the user identity from the token, determines whether the user has permission, as well as the corresponding data row and column permissions, and then returns the query result.
  (5) (This step is performed automatically by the product dashboard) The product dashboard Iframe receives the data returned by the Smart Data Insights system backend and renders the data.
  (6) Process ends.

2.1 Request description

DELETE /aeolus/api/open/v2/dashboard/dashboards
Permissions: Only dashboards for which you have management permissions can be deleted. Deleting other users' personal dashboards or directories is not supported.

2.2 Request headers

2.3 Request parameters

2.4 Response parameters

2.5 Response example

{
    "code": "aeolus/ok",
    "data": {
        "results": [
            {
                "dashboard": ******,
                "reason": "资源已被删除",
                "success": false
            },
            {
                "dashboard": ******,
                "reason": null,
                "success": true
            }
        ]
    },
    "msg": "成功"
}

Background: Users enter information into a Lark spreadsheet through a third-party web form, then use this Lark spreadsheet to directly create a dataset, which is analyzed on the dashboard.
Based on this context, users can navigate from the dashboard to the data entry web page, enter data into the Lark sheet on the web page, and after clicking "Complete" on the web page, close the content pop-up and refresh the dashboard according to the updated Lark sheet.