Guide
Product Credential Lifecycle
How product-scoped credentials move from dashboard creation to package embedding, Test Connection, licensing, rotation, revocation, and recovery.
SoundSync
Dashboard credential surface
The product credential controls expose masked previews, active/revoked state, recovery actions, rotation, and revocation. Screenshots in public docs must remain sanitized.
SoundSync
Implementation path
Keep management calls in developer tooling and product credential calls in plugin runtime code.
-
Create or ensure credential
Use developer JWT endpoints from the dashboard or trusted developer tooling. Copy the one-time reveal immediately.
-
Generate package or config
Include Product ID, Developer ID, App ID, plugin key, plugin secret, API base URL, and environment in the generated config.
-
Run Test Connection
POST /api/plugin-connections/verify with productId, appId, pluginKey, and pluginSecret in JSON body.
-
Run activation smoke
Exercise serial or customer-login activation, validate on startup, offline grace, and deactivation with fake/demo test data.
-
Rotate or revoke intentionally
After rotation or revocation, regenerate packages and update any custom config before release.
SoundSync
Management behavior
These behaviors are taken from the current controller/service contract.
| Action | Endpoint | Behavior | Package action |
|---|---|---|---|
| Lost visible secret | Call reveal-secret if the platform reports has_recoverable_secret. | If PRODUCT_CREDENTIAL_SECRET_UNAVAILABLE is returned, rotate-secret and regenerate the package. | |
| Secret exposed in logs/support | Rotate-secret. | Ship updated config/package. Treat older package builds as unable to authenticate once old credential is revoked. | |
| Plugin key exposed or confused with old config | Rotate-key. | The current platform rotates the pair, so copy both replacement values from the one-time reveal. | |
| Credential revoked intentionally | Create or ensure a new active credential before testing. | Run Test Connection, then run serial/customer-login activation and validation smoke. | |
| Generated HISE package still fails | Confirm package was regenerated after rotation and copied into the active HISE project. | Check App ID, plugin key preview, secret preview, Product ID, environment, and API base URL. |
Legacy fallback boundary
Legacy developer-level plugin key creation and secret reveal are disabled with 410 responses. Any platform compatibility fallback is not the current public product credential model and should not be used for new integrations.
