Plugin SDK

Build integrations for SSP POS and reach restaurants worldwide.

What can you build?

Type	Purpose	Status
💳 Payment	Card, UPI, QR and wallet processing	Available
🚚 Delivery	Uber Eats, DoorDash, Skip the Dishes and similar	Available
📦 Inventory	Stock tracking, movements, reorder alerts	Available
💼 Accounting	QuickBooks, Xero, FreshBooks	Buildable today (read + webhooks)
📧 Marketing	Email, SMS, campaigns	Buildable today (read + webhooks)
📊 Analytics	Business intelligence and dashboards	Buildable today (read + webhooks)
🎁 Loyalty	Rewards and points	Buildable today (read + webhooks)
👥 HR & Payroll	Scheduling and time tracking	Planned
🍽️ Reservation	Table booking	Planned

All nine categories are accepted values when you register a plugin. What they can reach differs:

• Available: dedicated write endpoints and webhook events. Payment captures, order creation and state, menu availability, stock and movements.
• Buildable today: no dedicated write endpoints, but the read API (orders, customers, menu, locations) and the order.* / payment.* webhooks are enough to run the integration. A loyalty plugin, for example, listens for order.paid (or is handed an SSP order code), calls GET /orders/{orderId} (the numeric id or the order code both work) to get total_amount and the customer, and keeps the points per customer in its own system. Loyalty apps are already built this way. What a plugin can't do yet is write points or rewards back into SSP.
• Planned: SSP has table booking and time tracking in the app, but they are not exposed to plugins yet: no endpoints and no events.

See Plugin Types for exactly what each one can 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.

Four credentials, four jobs

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

Credential	Format	Who holds it	Used for
Portal session	JWT, 4 hours	You, in the browser	The Developer Portal UI
Developer key	ssp_dev_… (40 chars)	Your CI / scripts	Managing projects, plugins, sandboxes programmatically
Installation key	pik_… (68 chars)	Your running plugin	The Plugin Data API — reading and writing restaurant data
Webhook secret	64 chars	Your running plugin	HMAC-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

• Developer Account — register, verify, keys, projects, teams
• Getting Started — your first working integration
• Sandboxes — isolated test environments and their lifecycle

Building

• Authentication — credentials and HMAC signing
• Plugin Types — the nine categories and what they reach
• Plugin Data API — narrative guide with worked examples
• API Reference — every endpoint, error code, and limit
• Webhooks — the event catalog, in both directions
• Setup Handoff — hosting your own configuration UI

Shipping

• Plugin Lifecycle — review, pricing, publishing, suspension
• Security — hardening your plugin

Integration guides

• Payment Gateways
• Delivery Platforms

Examples

Complete integrations

• Razorpay UPI Gateway (Node.js)
• DoorDash Delivery (Python)

Starter templates

• Minimal templates in Node.js, Python, PHP, and Go

Support

• Email: developers@ssppos.com
• GitHub: github.com/ssppos/examples

Commercial support

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

Contact: partnerships@ssppos.com