Skills Development Framer SDK Setup and API Authentication

Framer SDK Setup and API Authentication

v20260423
framer-install-auth
This guide provides comprehensive instructions for setting up and authenticating Framer development environments. It covers two primary surfaces: the Plugin SDK (for UI running inside the editor) and the Server API (for headless CMS synchronization or CI/CD). Users will learn how to initialize projects, configure environment variables, and connect both client-side and server-side components.
Get Skill
315 downloads
Overview

Framer Install & Auth

Overview

Set up the Framer Plugin SDK for building editor plugins, or the framer-api package for Server API access. Framer has two developer surfaces: Plugins (run inside the Framer editor UI) and Server API (run from any Node.js server via WebSocket).

Prerequisites

  • Node.js 18+
  • Framer account (free or paid)
  • For Server API: API key from site settings

Instructions

Step 1: Choose Your Integration Type

TypePackageUse Case
Pluginframer-pluginUI that runs inside Framer editor
Server APIframer-apiHeadless CMS sync, CI/CD publishing
Code ComponentsReact in FramerCustom components on the canvas
Code OverridesReact in FramerModify existing component behavior

Step 2: Set Up a Framer Plugin

# Scaffold a new plugin project
npx create-framer-plugin@latest my-plugin
cd my-plugin
npm install
npm run dev

This creates a Vite + React project with the framer-plugin package pre-configured. The plugin runs inside Framer's editor iframe.

Step 3: Set Up the Server API (Headless Access)

npm install framer-api
// server.ts — Server API connection
import { framer } from 'framer-api';

const client = await framer.connect({
  apiKey: process.env.FRAMER_API_KEY!, // From site settings
  siteId: process.env.FRAMER_SITE_ID!,
});

// List all CMS collections
const collections = await client.getCollections();
console.log('Collections:', collections.map(c => c.name));

Step 4: Configure Environment Variables

# .env (NEVER commit)
FRAMER_API_KEY=framer_sk_abc123...
FRAMER_SITE_ID=abc123def456

# .gitignore
.env
.env.local

Step 5: Verify Plugin Connection

Open Framer, go to your project, click Plugins > Development > select your local plugin. The dev server hot-reloads into the editor.

// Plugin verification — runs inside Framer editor
import { framer } from 'framer-plugin';

export function App() {
  const handleTest = async () => {
    const selection = await framer.getSelection();
    console.log('Selected layers:', selection.length);
    framer.notify(`Found ${selection.length} selected layers`);
  };

  return <button onClick={handleTest}>Test Connection</button>;
}

Output

  • Plugin project scaffolded with Vite + React
  • Server API client connected via WebSocket
  • Environment variables configured
  • Verified connection to Framer editor or API

Error Handling

ErrorCauseSolution
Plugin not showingDev server not runningRun npm run dev and reload Framer
Invalid API keyWrong key or site IDGenerate new key in site settings
WebSocket connection failedNetwork/firewallAllow outbound WSS connections
framer-plugin not foundMissing dependencyRun npm install framer-plugin

Resources

Next Steps

After setup, proceed to framer-hello-world for your first plugin or component.

Info
Category Development
Name framer-install-auth
Version v20260423
Size 3.71KB
Updated At 2026-04-26
Language