Aller au contenu principal

Plugin SDK

Build integrations for SSP POS and reach restaurants worldwide.

What can you build?​

TypePurposeStatus
💳 PaymentCard, UPI, QR and wallet processingAvailable
🚚 DeliveryUber Eats, DoorDash, Skip the Dishes and similarAvailable
📦 InventoryStock tracking, movements, reorder alertsAvailable
💼 AccountingQuickBooks, Xero, FreshBooksPlanned
📧 MarketingEmail, SMS, campaignsPlanned
📊 AnalyticsBusiness intelligence and dashboardsPlanned
👥 HR & PayrollScheduling and time trackingPlanned
🍽️ ReservationTable bookingPlanned
🎁 LoyaltyRewards and pointsPlanned

All nine categories are accepted values when you register a plugin, but only payment, delivery, and inventory have dedicated data endpoints and webhook events shipping today. See Plugin Types for what each one can actually reach.

How it works​

Your plugin is your own service, on your own infrastructure. SSP never runs your code. The two systems talk over HTTPS in both directions:

  1. A restaurant installs and configures your plugin from the SSP Marketplace.
  2. SSP pushes signed webhooks to your endpoint when things happen.
  3. Your plugin reads and writes restaurant data through the Plugin Data API.
  4. Your plugin talks to whatever third-party provider it integrates.

Three credentials, three jobs​

This is the single most common source of confusion, so it's worth getting straight up front:

CredentialFormatWho holds itUsed for
Portal sessionJWT, 4 hoursYou, in the browserThe Developer Portal UI
Developer keyssp_dev_… (40 chars)Your CI / scriptsManaging projects, plugins, sandboxes programmatically
Installation keypik_… (68 chars)Your running pluginThe Plugin Data API — reading and writing restaurant data
Webhook secret64 charsYour running pluginHMAC-SHA256 signing, in both directions

Full detail in Authentication.

Quick start​

1. Create your developer account​

Register at the Developer Portal, verify your email, and accept the developer agreements. See Developer Account.

2. Create a project and provision a sandbox​

Every project gets an isolated sandbox pre-seeded with realistic restaurant data. Provisioning returns two secrets, each shown once:

  • a pik_ API key for the Plugin Data API
  • a webhook_secret for HMAC-SHA256 signing

3. Call the Plugin Data API​

curl "https://api.ssppos.com/api/plugin/v1/orders" \
  -H "X-Plugin-Api-Key: pik_YOUR_KEY"

Your sandbox already has locations, menus, orders, customers and inventory — you can start building immediately.

4. Build, test, publish​

Fire test webhooks at your endpoint from the portal, then promote your project's scaffold into a real plugin, submit it for review, and publish it to the marketplace.

Walkthrough: Getting Started.

Monetization​

Marketplace v1 supports free and subscription plugins. Subscriptions bill monthly or yearly through Stripe, with an optional card-up-front free trial. The published revenue share is 80% to the developer.

Payouts are not automated yet

The v1 billing pipeline records the full invoice against the platform and does not yet compute or disburse a developer split — that arrives in a later phase. Settle payout terms and timing with partnerships@ssppos.com before you build a financial model on it.

Pricing mechanics are covered in Plugin Lifecycle.

Documentation map​

Start here

Building

Shipping

Integration guides

Examples​

Complete integrations

Starter templates

Support​

Commercial support​

  • Consulting: $150/hour
  • Full integration development: from $5,000
  • Plugin certification: $1,000

Contact: partnerships@ssppos.com