Developer Portal

    Build on SPARC

    REST API, WebSocket player protocol, webhooks, and a custom widget API. Build custom players, integrate your data sources, and automate your screen workflows.

    What you can build

    Four integration surfaces — each one documented, versioned, and production-tested.

    REST API

    Full CRUD control over screens, content, playlists, schedules, and analytics via a RESTful API. Push content to any screen programmatically, trigger emergency alerts, retrieve proof-of-play data.

    POST /api/v1/screens/{id}/deploy

    WebSocket Player Protocol

    Build a fully custom media player that speaks SPARC's WebSocket protocol. Players send status, receive content commands, and participate in sync groups — native app performance, SPARC intelligence.

    wss://api.mysparc.app/player/ws

    Webhooks

    Subscribe to events — content deployed, screen went offline, proof-of-play recorded, audience threshold crossed — and trigger downstream workflows in your own systems.

    event: screen.offline → your endpoint

    Custom Data Widgets

    Build HTML/JavaScript widgets that run inside SPARC zones. Receive live data via the widget API, react to audience events, and render whatever your use case demands.

    window.SPARC.onData(payload => { ... })

    Quick start

    Three requests to get your first integration running.

    01 — Authenticate
    curl -X POST https://api.mysparc.app/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{"api_key": "sk_live_..."}'
    02 — Deploy content to a screen
    curl -X POST https://api.mysparc.app/v1/screens/scr_abc/deploy \
  -H "Authorization: Bearer {token}" \
  -d '{"playlist_id": "pl_xyz", "immediate": true}'
    03 — Subscribe to events (WebSocket)
    const ws = new WebSocket(
  "wss://api.mysparc.app/player/ws"
);
ws.send(JSON.stringify({
  type: "pair",
  code: "ABC123"
}));

    Common use cases

    Custom media player

    Rust, Electron, or native Android — build a player optimised for your hardware. Pair with a 6-character code, authenticate with a device token, and receive content via WebSocket.

    ERP & POS integration

    Push live pricing, inventory levels, queue depth, or sales data directly from your POS or ERP to SPARC screens. No manual updates, no CSV exports.

    Custom SSO provider

    Enterprise accounts can integrate any SAML 2.0 or OIDC identity provider. Manage SPARC access through the same IdP you use for every other enterprise tool.

    Automation & workflows

    Use webhooks + REST API to wire SPARC into Zapier, Make, or n8n. Trigger content changes from CRM updates, calendar events, IoT sensor readings, or any business system.

    Start building today

    Create a free account to get your API key. Full documentation is available publicly — no account required to read.

    Questions? Talk to our developer team.