API reference
API Idempotency
Idempotency guidance for activation, checkout, external orders, partner actions, webhooks, refunds, and retry-safe client behavior.
POST /activateGET /validatePOST /deactivate
Product credentials
Activation request
Entitlement check
Device registration
Periodic validation
Deactivation when needed
SoundSync
Reference shape
Every API group follows the same integration documentation pattern.
| Field | Guidance |
|---|---|
| Purpose | What the endpoint group is used for and which product/customer state it can affect. |
| Method and route | HTTP method, route pattern, and product/customer scope. |
| Headers | Authentication, content type, idempotency key where applicable, and webhook signature where applicable. |
| Parameters | Path, query, and body parameters with required/optional status. |
| Request example | Sanitized request shape using demo values only. |
| Success response | Sanitized response shape and important state transitions. |
| Error response | Error code, message, retry guidance, and support path. |
| Side effects | Order, entitlement, activation, device, library, webhook, billing, or reporting changes. |
| Related endpoints | Next integration calls and troubleshooting references. |