API reference
Delivery and Downloads API
Endpoint reference for entitlement-gated file downloads, protected proxy downloads, wrapped external downloads, product download codes, and customer library calls.
Product credentials
Activation request
Entitlement check
Device registration
Periodic validation
Deactivation when needed
SoundSync
Delivery, protected downloads, and customer library calls
Download APIs should be called only with the correct entitlement, token, code, or customer-library context.
/api/delivery/entitlements/:entitlementId/files/:fileIndex
Download an entitlement-authorized file.
- Auth
- Customer entitlement/download context
- Scope
- Product or storefront scoped
- Request fields
- entitlementId and fileIndex path parameters plus request token/session context.
- Returns
- Authorized redirect to short-lived signed R2 delivery, or authorization error.
/api/download/proxy
Authorize a legacy protected file download and redirect to signed R2 delivery.
- Auth
- Download authorization context
- Scope
- Product or storefront scoped
- Request fields
- Download location and token query supported by the API.
- Returns
- Authorized redirect to short-lived signed R2 delivery.
/api/download/wrapped
Authorize a legacy indexed file download and redirect managed files to signed R2 delivery.
- Auth
- Download authorization context
- Scope
- Product or storefront scoped
- Request fields
- Wrapped external download query supported by the API.
- Returns
- Authorized redirect to short-lived signed R2 delivery, or an import-required error for unmanaged external assets.
/api/products/download/:code
Resolve product download links by download code.
- Auth
- Download code
- Scope
- Product or storefront scoped
- Request fields
- code path parameter.
- Returns
- Authorized download links for the product/order context.
/api/products/download/:code/:filename
Download one product file by code and filename.
- Auth
- Download code
- Scope
- Product or storefront scoped
- Request fields
- code and filename path parameters.
- Returns
- Protected file response.
/api/library/claim
Claim a library item into the signed-in account.
- Auth
- Developer/customer account token depending on library flow
- Scope
- Product or storefront scoped
- Request fields
- Product, order, or serial context supported by the library API.
- Returns
- Claim result and updated library state.
/api/library
Load customer library.
- Auth
- Customer account/session context
- Scope
- Product or storefront scoped
- Returns
- Owned products, downloads, serial/license details, subscriptions, and support links.
/api/library/expansions
List expansion library entries.
- Auth
- Public/customer library context depending on route usage
- Scope
- Product or storefront scoped
- Returns
- Expansion library payload.
/api/library/products/:productId/expansions
List expansions for a product.
- Auth
- Public/customer library context depending on route usage
- Scope
- Product or storefront scoped
- Returns
- Product expansion payload.
/api/library/products/:productId/reviews
List or submit product reviews from library context.
- Auth
- Customer/library context for submission
- Scope
- Product or storefront scoped
- Request fields
- Review payload for POST.
- Returns
- Review list or created review state.
