Quickstart

Get started with the Widgetic API in minutes

This guide will help you make your first API call to Widgetic in just a few minutes.

​

Prerequisites

Before you begin, make sure you have:

1. A Widgetic account (sign up here)
2. An API key from your dashboard
3. A basic understanding of REST APIs

​

Step 1: Get Your API Key

1. Log in to your Widgetic dashboard
2. Navigate to Settings > API Keys
3. Click Generate New Key
4. Copy your API key (it starts with wgt_usr_ for user keys)

Keep your API key secure! Never expose it in client-side code or public repositories.

​

Step 2: Make Your First Request

Let’s verify your API key by fetching your user profile:

cURL

curl -X GET "https://api.widgetic.com/v1/users/me" \
  -H "Authorization: Bearer YOUR_API_KEY"

​

Step 3: Explore the API

Now that you’re authenticated, here are some common next steps:

List Your Widgets

Fetch all widgets in your account

Create a Canvas

Start designing a new widget

Get Compositions

View your widget compositions

Check Entitlements

See access levels and entitlement endpoints

​

Using the TypeScript SDK

We recommend using our TypeScript SDK for the best developer experience:

npm install @widgetic/api-sdk-ts

The SDK provides type-safe access to all API endpoints:

import { WidgetsApi, CompositionsApi, CanvasesApi } from '@widgetic/api-sdk-ts';

// Initialize with your API key
const widgets = new WidgetsApi('YOUR_API_KEY');
const compositions = new CompositionsApi('YOUR_API_KEY');
const canvases = new CanvasesApi('YOUR_API_KEY');

// Fetch widgets with pagination
const { data, meta } = await widgets.getWidgets({ page: 1, size: 20 });
console.log(`Found ${meta.total} widgets`);

​

Next Steps

1. Learn Authentication

   Understand the different authentication methods available.

2. Choose Your Path

   • Partners: Start with Partner Overview
   • Self-Serve: Start with API Overview
3. Explore Examples

   Check out our code examples for common use cases.