API & SDK Quick Start
Use the Simplio3D API and JavaScript SDK to build fully custom 3D configurator experiences. This guide helps you get started quickly.
Step 1: Generate an API Key
- 1Go to Dashboard > Integrations.
- 2Find the "API Keys" section.
- 3Click "Generate New API Key".
- 4Give the key a descriptive name (e.g., "Production Website", "Staging").
- 5Copy the generated key immediately — it won't be shown again.
- 6Store the key securely (environment variables, not in client-side code).
Step 2: Make Your First API Call
// List all your projects
const response = await fetch(
'https://your-instance.supabase.co/functions/v1/make-server-0532dd87/projects',
{
headers: {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
'Content-Type': 'application/json'
}
}
);
const data = await response.json();
console.log(data.projects);
Step 3: Use the JavaScript SDK
The SDK provides a higher-level interface for embedding and controlling the 3D viewer programmatically.
// Install the SDK
npm install @simplio3d/sdk
// Initialise the viewer
import { Simplio3D } from '@simplio3d/sdk';
const viewer = new Simplio3D({
container: '#viewer-container',
projectId: 'YOUR_PROJECT_ID',
token: 'YOUR_SHARE_TOKEN',
});
await viewer.init();
What You Can Do
Embed 3D Viewers
Embed interactive 3D viewers with full camera control, lighting, and animation support.
Control Options
Programmatically set option values, listen for changes, and react to user selections.
Calculate Prices
Trigger price calculations and receive the result, including breakdowns per option.
Submit Forms
Submit quote requests programmatically with custom form data.
Full Documentation
For complete API endpoint reference and SDK method documentation, visit: