Developer Documentation

APIs, SDKs, and integration guides for ChromaSync

Getting Started

ChromaSync provides enterprise-grade APIs for color management, palette synchronization, and accessibility compliance. Our REST API and SDKs allow you to integrate ChromaSync's powerful color management capabilities into your applications.

Authentication

All API requests require authentication using OAuth 2.0 + PKCE or API keys for server-to-server integrations.

Quick Start

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.chromasync.app/v1/palettes

API Reference

Palettes API

Manage color palettes, versions, and team permissions.

GET /v1/palettes
POST /v1/palettes
PUT /v1/palettes/:id
DELETE /v1/palettes/:id

Colors API

WCAG compliance checking and color space conversions.

GET /v1/colors/:hex/wcag
POST /v1/colors/convert
GET /v1/colors/harmony

Teams API

Manage team members, permissions, and audit logs.

GET /v1/teams
POST /v1/teams/members
GET /v1/teams/audit

Export API

Export palettes to various formats and design tools.

GET /v1/export/figma
GET /v1/export/sketch
GET /v1/export/css

SDKs & Libraries

TypeScript/JavaScript

Official SDK for Node.js and browsers

npm install @chromasync/sdk

Python

Python SDK for backend integrations

pip install chromasync

REST API

Direct HTTP API for any language

api.chromasync.app

Popular Integrations

Figma Plugin

Sync palettes directly with Figma

Sketch Plugin

Native Sketch integration

Slack Integration

Palette updates in Slack

Jira Integration

Link colors to design tickets

Code Examples

Create a New Palette

const chromasync = new ChromaSync({ apiKey: 'your_api_key' });

const palette = await chromasync.palettes.create({
  name: 'Brand Colors 2025',
  colors: [
    { name: 'Primary', hex: '#9333EA' },
    { name: 'Secondary', hex: '#7C3AED' },
    { name: 'Accent', hex: '#C084FC' }
  ],
  tags: ['brand', 'primary'],
  team: 'design-team'
});

console.log('Palette created:', palette.id);

Check WCAG Compliance

const result = await chromasync.colors.checkWCAG({
  foreground: '#9333EA',
  background: '#FFFFFF',
  standard: 'WCAG3'
});

if (result.passes) {
  console.log('✅ Passes WCAG 3.0 AA');
} else {
  console.log('❌ Fails:', result.reason);
}