Skip to main content
This guide covers how to create dashboards for your tenants using the Papermap Dashboard API.
The dashboardId created through this flow can be used in both iframe embedding and React component embedding with @papermap/papermap.

Prerequisites

Before implementing, ensure you have:
  • Papermap API credentials (API Key ID and Secret Key)
  • Your workspace ID
  • API endpoint URL (obtain from your Papermap dashboard settings)
  • HMAC authentication implemented (see Authentication)

Database Model

First, you should have created a table in your database to store the mapping between your tenant and the dashboard ID. See the Database Model section in Backend Implementation for details. Purpose: Links your tenant to a Papermap dashboard ID for secure access and isolation.

Creating a Dashboard

The base URL for the Papermap API is https://prod.dataapi.papermap.ai/.
The get_auth_headers function is a helper function that generates the HMAC signature for the API request found in the HMAC Authentication
Create a dashboard via the Papermap API for each tenant:

Workflow Diagram

Key Considerations

Tenant Isolation

Each tenant should have their own dashboard:
  • One dashboard per tenant ensures data isolation
  • Store the tenant-to-dashboard mapping in your database
  • Verify tenant ownership before allowing access

Dashboard Naming

Use clear, consistent naming conventions:
  • Include tenant identifier in dashboard name
  • Example: "Dashboard - Acme Corp" or "Acme Corp Analytics"
  • Makes management easier in the Papermap admin panel

Error Handling

Handle common errors gracefully:

Next Steps

Generate Iframe Tokens

Learn how to generate secure embed tokens for your dashboards

API Endpoints

Set up REST API endpoints for dashboard operations