Skip to content
SoundSyncAudio software platform

Guide

Customer Login Activation

Activate a machine with customer account identity using POST /api/license/v1/customer-login/activate.

SoundSync

Endpoint contract

Use canonical field names in new clients. Aliases are compatibility only.

POST /api/license/v1/customer-login/activate

Activate by customer account identity when the product supports account/login activation.

Auth
Standard custom HTTP/HISEScript product credential path: x-ss-app-id, x-ss-plugin-key, and x-ss-plugin-secret. Generated native clients use their supported public-client identity and customer/machine proof path; see /docs/authentication.
Scope
Product, app, credential, environment, and machine scoped.
Request fields
  • email
  • password or customer_token
  • instance_id or machine_id
  • product_id/app context when required
  • plugin_version optional
Returns
activation result with validation token, entitlement/customer details, device limit and subscription state where applicable.
Notes
Never cache the customer password. Store only returned activation state and validation token.

SoundSync

Canonical request

Never cache the raw password. Persist only returned activation state.

cURL
curl -sS -X POST "$SOUNDSYNC_API_BASE/api/license/v1/customer-login/activate" \
  -H "Content-Type: application/json" \
  -H "x-ss-app-id: ss_prod_demoapp123" \
  -H "x-ss-plugin-key: ss_pk_demokey123" \
  -H "x-ss-plugin-secret: ss_ps_demosecret123" \
  -d '{
    "email": "customer@example.invalid",
    "password": "do-not-cache-this",
    "instance_id": "machine-demo-001",
    "product_id": "prod_demo_piano",
    "plugin_version": "1.0.0"
  }'

SoundSync

Compatibility aliases

Accept aliases only to support older integrations; new docs and examples use canonical names.

CanonicalAccepted aliases
emailcustomerEmail, customer_email, license_email, licenseEmail
passwordcustomerPassword, customer_password, loginSecret, login_secret, customerLoginSecret, customer_login_secret, accountPassword, account_password, accountSecret, account_secret, secret
customer_tokencustomerToken, customerJwt, customer_jwt
instance_idmachine_id, uid

SoundSync

Failure behavior

Customer-login failures are explicit platform decisions, not offline-grace events.

FailureExpected behavior
Invalid loginKeep activation UI open. Do not cache password or unlock.
Customer not entitledShow product ownership/support path.
subscription_payment_requiredLock access and route to billing/support.
Device limit reachedShow device management or support.
Product disabled or credential failureBlock activation and show developer diagnostic without exposing secrets.

Package-specific access policy

JUCE 0.7.0 requires online renewal at startup. Valid saved credentials are reused without repeated sign-in, but offline audio access is unavailable in this release. HISEScript offline grace is a different package policy.