API Reference

Customer Library API

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

Start with getting started Explore API docs

POST /activateGET /validatePOST /deactivate

Product credentials
Activation request
Entitlement check
Device registration
Periodic validation
Deactivation when needed

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.

Purchase/order
Checkout or partner fulfillment records product access.
Entitlement
Entitlement state is the access source used by delivery.
Customer account/link
Customer identity service resolves user/customer IDs from the token.
Library item
GET /api/library returns products, serials/licenses, subscriptions, and support context.
Download
Download links point to entitlement-gated delivery routes.
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.

API reference

Endpoint groups are organized by authentication model, product scope, request shape, response shape, errors, idempotency, and integration surface.

GET/POST