api-embed-carousel

Author: pballai

embedding_qs_series_2_api_use_cases/.env

@@ -15,9 +15,9 @@ EMBED_URL_BASE=https://app.sigmacomputing.com
 
 # Sigma Organization and Client Credentials
 # Update these with your actual organization and client credentials
-ORG_SLUG=
-CLIENT_ID=
-SECRET=
+ORG_SLUG=quick-starts-fundamentals
+CLIENT_ID=8f92dcde4c89a9cc56c8791b65e5862b71b5672ef6cb5a0d605564defa84a3af
+SECRET=f2794b7eb3876bd58c588e398305fce8f5d73001e5df66fd63de87b8fdef269f4ff8c3e279c09c51973c18262d144329f0f9eb4566382c8923acb50d3e9f6b9d
 
 # =============================================================================
 # APPLICATION CONFIGURATION  
@@ -37,7 +37,7 @@ WORKBOOK_NAME=Embed_API_QuickStart
 # USER PROVISIONING CONFIGURATION
 # =============================================================================
 # Admin user required for provisioning operations
-ADMIN_EMAIL=
+ADMIN_EMAIL=[email protected]
 
 # Workspace configuration
 WORKSPACE_NAME=Embed_Users
@@ -69,7 +69,7 @@ HIDE_VIEW_SELECT=false
 
 # Interface Configuration
 MENU_POSITION=none
-THEME=Lite
+THEME=Li
 LNG=English
 
 # Responsive and Mobile Settings  
@@ -79,4 +79,4 @@ RESPONSIVE_HEIGHT=false
 
 # Page and View Targeting (leave empty for workbook-level embedding)
 PAGE_ID=
-VIEW_ID=
+VIEW_ID=

embedding_qs_series_2_api_use_cases/data/default-workbooks.json

@@ -1,3 +1,12 @@
 {
-  "defaults": []
+  "defaults": [
+    {
+      "userEmail": "[email protected]",
+      "memberID": "Upf4cYouz5fAvk1SDH80L4pGihtUg",
+      "workbookName": "Plugs Transactions",
+      "workbookUrlId": "6QEnNYADhD50tbSnlwMltH",
+      "createdAt": "2025-08-08T19:33:58.595Z",
+      "updatedAt": "2025-08-08T19:33:58.595Z"
+    }
+  ]
 }

embedding_qs_series_2_api_use_cases/public/api-enbed-carousel/README.md

@@ -0,0 +1,64 @@
+# API Getting Started QuickStart
+
+## Overview
+This is the foundational QuickStart page that demonstrates the basic Sigma embedding workflow using JWT authentication. It provides a simple interface to select users and workbooks, and displays the embedded Sigma content.
+
+## Features
+- User Selection: Switch between View Users and Build Users to see different permission levels
+- Workbook Selection: Choose from available workbooks in your Sigma environment
+- JWT Token Display: View the generated JWT token and its decoded payload for learning purposes
+- Information Panel: Toggle sidebar showing embed URL, JWT token, and decoded JWT payload
+- Responsive Design: Clean, mobile-friendly interface
+
+## How It Works
+
+### Authentication Flow
+1. Select a user (View or Build user) from the dropdown
+2. Choose a workbook to embed
+3. The application generates a JWT token with appropriate claims for the selected user
+4. The JWT is used to authenticate and authorize the embedded Sigma content
+
+### User Types
+- View Users: Can view and interact with the embedded content but cannot edit
+- Build Users: Have full editing capabilities within the embedded workbook
+
+## Technical Implementation
+- JWT Generation: Uses `/api/jwt/api-getting-started` endpoint
+- Workbook Data: Fetches available workbooks from `/api/workbooks`
+- Environment Config: Loads configuration from `/env.json`
+- Debug Mode: Enable DEBUG=true in .env file for detailed console logging
+
+## File Structure
+```
+api-getting-started/
+├── index.html          # Main page with embedded Sigma content
+└── README.md           # This documentation
+```
+
+## API Endpoints Used
+- `GET /api/workbooks` - Fetches available workbooks
+- `POST /api/jwt/api-getting-started` - Generates JWT token for embedding
+
+## Configuration
+The page respects all embedding configuration options from your `.env` file:
+- `hide_folder_navigation`
+- `hide_menu`
+- `menu_position`
+- `theme`
+- `lng` (language)
+- And other standard Sigma embedding parameters
+
+## Getting Started
+1. Ensure your `.env` file is properly configured with Sigma API credentials
+2. Start the server: `npm start`
+3. Navigate to `/api-getting-started`
+4. Select a user and workbook to see the embedded content
+5. Use the Toggle Info Panel to view JWT details and debug information
+
+## Debug Information
+When DEBUG=true is set in your environment:
+- Console logging shows detailed JWT information
+- Embed URL and token details are displayed in the sidebar
+- User selection and workbook loading events are logged
+
+This QuickStart serves as the foundation for understanding Sigma embedding concepts before exploring more advanced features in the other API examples.