Guide
API and Plugin Integration Overview
Start here to choose a SoundSync plugin integration path, find credentials, pass Test Connection, activate, validate, handle offline grace, and deactivate.
SoundSync
Minimum Paid Product Price
Products sold through SoundSync checkout must be priced at $9.99 or higher.
Paid checkout rule
Minimum product price: $9.99 for paid products.
Free products
Products can still use supported free, promo, manual grant, reseller, migration, serial-generator, or external-redemption flows where configured. The $9.99 minimum applies to paid products sold through SoundSync checkout.
Checkout validation
Checkout pricing is validated server-side, so product price, sale price, promo codes, subscriptions, and checkout totals should be configured with the paid-product minimum in mind.
SoundSync
Recommended path
Follow this order for a first custom plugin integration.
-
Choose an integration path
Use HISE package when you want the maintained HISE runtime. Use Custom JUCE/C++ when you will implement HTTP, activation UI, persistence, validation, grace, and deactivation yourself.
-
Create product credentials
Record Product ID, App ID, plugin key, plugin secret, environment, and API base URL from product setup. Do not ask customers to enter these values.
-
Pass Test Connection
Call POST /api/plugin-connections/verify with productId, appId, pluginKey, and pluginSecret in the JSON body.
-
Implement activation
Choose serial claim, direct serial activation, customer-login activation, or login-or-serial based on the product mode.
-
Persist returned activation state
Encrypt/cache the fields returned by activation. Never cache customer passwords or write plugin secrets to logs.
-
Validate on startup
Validate cached state with /api/license/v1/validate, rotate stored token when returned, and lock on explicit denials.
-
Handle grace and deactivation
Use offline grace only for temporary transport failures after a prior valid state, then delete local state on deactivation.
SoundSync
Primary guides
These are the implementation pages most developers need.
Choose Your Integration
Decide between generated HISE, current JUCE status, custom JUCE/C++, server-side, and storefront/library paths.
Plugin Credentials and Identifiers
Exact credential names, examples, sensitivity, rotation, and request anatomy.
Test Connection
The exact request and failure codes for plugin connection verification.
Serial Activation
Claim, email verification, final activation, persistence, and resume behavior.
Validate on Startup
Startup validation and local access decisions.
Offline Grace
When grace may and may not unlock access.