Skip to content
SoundSyncAudio software platform

API Reference

Customer Library API

Verified customer-library token, listing, webview-library, expansion, review, and claim boundaries.

Start with getting startedExplore API docs

SoundSync

Verified library endpoints

These endpoints are route-backed and scoped by customer/library token where noted.

GET /api/library

Return customer portal/library payload for a library token.

Auth
Customer library token via Authorization: Bearer <token>, token, download_token, or libraryToken.
Scope
Customer identity plus optional storefront/developer scope.
Request fields
  • Bearer/query library token
  • optional storefront/storefrontSlug scope
  • optional instance_id/instanceId/machine_id
Returns
Products, subscriptions, licenses/serials, orders, marketing preferences, account profile, support, and download_token.
Side effects
None for GET endpoints unless noted.
GET/POST /api/license/v1/library-token

Issue or return a customer library token for plugin/webview customer-library access.

Auth
Plugin/customer context as implemented by the licensing controller. Do not treat this as a developer API key.
Scope
Customer/library session scope.
Request fields
  • Customer/license context accepted by the licensing controller
Returns
Library token response used by HISE storefront package and webview-library flows.
Side effects
None for GET endpoints unless noted.
GET/POST /api/license/v1/webview-library

Return webview customer-library payload for plugin-hosted library experiences.

Auth
Plugin/customer context as implemented by the licensing controller.
Scope
Customer library and product/storefront scope.
Request fields
  • Library token or plugin/customer context
Returns
Customer library payload suitable for in-plugin WebView use.
Side effects
None for GET endpoints unless noted.
POST /api/library/claim

Claim an external reseller/partner order item into the authenticated customer/developer account.

Auth
Authenticated SoundSync user JWT.
Scope
Public, customer-token, developer-user, or scoped partner API surface as noted.
Request fields
  • Developer/customer user JWT
  • claim or claim_token body/query value
Returns
Claim result or LIBRARY_CLAIM_FAILED error.
Side effects
Claims an external reseller order item when the claim token is valid.

SoundSync

Purchase to library flow

This is the verified conceptual flow; do not expose internal-only endpoints.

  1. Purchase/order

    Checkout or partner fulfillment records product access.

  2. Entitlement

    Entitlement state is the access source used by delivery.

  3. Customer account/link

    Customer identity service resolves user/customer IDs from the token.

  4. Library item

    GET /api/library returns products, serials/licenses, subscriptions, and support context.

  5. Download

    Download links point to entitlement-gated delivery routes.

  6. Plugin activation

    Licensing endpoints remain separate from library listing.

Public boundary

Customer website UI, embedded customer library, in-plugin WebView library, and developer API access are separate surfaces. Do not document internal customer tables or admin routes as public APIs.

SoundSync

Customer activation reset

POST /api/library/licenses/:kind/:licenseId/reset-activations

Reset the current customer's eligible device activations

Auth
Customer account Bearer token in the Authorization header. Shared library/download links are not accepted.
Scope
License ownership, developer reset enablement, cooldown, and storefront scope are checked.
Request fields
  • kind: serial or entitlement; licenseId: the corresponding customer-owned license.
  • expectedLastResetAt is required: the last value read by the customer, or null before a first reset; storefront query scope where applicable.
Returns
Updated reset result or an eligibility/conflict error; reload before another action.

Customer activation resets, when enabled

Developers can allow customer self-service resets for supported serial and entitlement licenses, with a configured cooldown. Only the signed-in owner of the license can request a reset. The confirmation clears the affected device activations and sessions together while preserving the license and product ownership.

A reset is not a refund, a new serial, or unlimited extra devices. Customers must reload the current state and wait for the next eligible reset when a cooldown applies.