Guide

Customer Login Activation

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

Start with getting started Explore API docs

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: Product plugin credential. Licensing endpoints require x-ss-app-id, x-ss-plugin-key, and x-ss-plugin-secret headers, or verified body/query aliases.
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.

Canonical	Accepted aliases
email	customerEmail, customer_email, license_email, licenseEmail
password	customerPassword, customer_password, loginSecret, login_secret, customerLoginSecret, customer_login_secret, accountPassword, account_password, accountSecret, account_secret, secret
customer_token	customerToken, customerJwt, customer_jwt
instance_id	machine_id, uid

SoundSync

Failure behavior

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

Failure	Expected behavior
Invalid login	Keep activation UI open. Do not cache password or unlock.
Customer not entitled	Show product ownership/support path.
subscription_payment_required	Lock access and route to billing/support.
Device limit reached	Show device management or support.
Product disabled or credential failure	Block activation and show developer diagnostic without exposing secrets.