Ziplabs Embedded SDK

The Embedded SDK allows you to embed dashboards from Ziplabs into your own app, using your app's authentication.

Embedding is done by inserting an iframe, containing a Ziplabs page, into the host application.

Embedding a Dashboard

Using npm:

npm install --save ziplabs-embedded-sdk

import { embedDashboard } from "ziplabs-embedded-sdk";

embedDashboard({
  id: "abc123", // given by the Ziplabs embedding UI
  ziplabsDomain: "http://localhost:8088/",
  mountPoint: document.getElementById("my-div-container"), // any html element that can contain an iframe
  fetchGuestToken: () => fetchGuestTokenFromBackend(),
  dashboardUiConfig: { // dashboard UI config: hideTitle, hideTab, hideChartControls, filters.visible, filters.expanded (optional)
      hideTitle: true,
      filters: {
          expanded: true,
      }
  },
});

Authentication/Authorization with Guest Tokens

Embedded resources use a special auth token called a Guest Token to grant Ziplabs access to your users, without requiring your users to log in to Ziplabs directly. Your backend must create a Guest Token by requesting Ziplabs's POST /security/guest_token endpoint, and pass that guest token to your frontend.

The Embedding SDK takes the guest token and use it to embed a dashboard.

Creating a Guest Token

From the backend, http POST to /security/guest_token with some parameters to define what the guest token will grant access to. Guest tokens can have Row Level Security rules which filter data for the user carrying the token.

The agent making the POST request must be authenticated with the can_grant_guest_token permission.

Within your app, using the Guest Token will then allow authentication to your Ziplabs instance via creating an Anonymous user object. This guest anonymous user will default to the public role as per this setting GUEST_ROLE_NAME = "Public". + +The user parameters in the example below are optional and are provided as a means of passing user attributes that may be accessed in jinja templates inside your charts.

Example POST /security/guest_token payload:

{
  "user": {
    "username": "stan_lee",
    "first_name": "Stan",
    "last_name": "Lee"
  },
  "resources": [{
    "type": "dashboard",
    "id": "abc123"
  }],
  "rls": [
    { "clause": "publisher = 'Nintendo'" }
  ]
}