Test Connection

Verify the standard product credential tuple or supported native public-client app/product identity before customer activation testing.

Auth

JSON body credential check. Headers are not used for this endpoint.

Scope

Product, app, credential, environment, and machine scoped.

Request fields

• productId and appId
• pluginKey and pluginSecret for standard custom HTTP/HISEScript credential verification
• publicClient: hise-native or juce-native for the generated native public-client path
• pluginVersion, environment, and metadata optional

Returns

ok/connected, productId, credentialId, pluginVersion, environment, lastSeenAt.

Side effects

Updates credential last-used state, upserts plugin connection status, and records a plugin connection event.

Notes

This endpoint reads its JSON body rather than substituting licensing headers. The native public-client path does not require a distributed pluginSecret. Connectivity/product identification is not customer entitlement or audio unlock.

curl -sS -X POST "$SOUNDSYNC_API_BASE/api/plugin-connections/verify" \
  -H "Content-Type: application/json" \
  -d '{
    "productId": "prod_demo_piano",
    "appId": "ss_prod_demoapp123",
    "pluginKey": "ss_pk_demokey123",
    "pluginSecret": "ss_ps_demosecret123",
    "pluginVersion": "1.0.0",
    "environment": "test"
  }'

SoundSync::CredentialConfig config;
config.apiBaseUrl = "https://api.soundsync.example";
config.productId = "prod_demo_piano";
config.appId = "ss_prod_demoapp123";
config.pluginKey = "ss_pk_demokey123";
config.pluginSecret = "ss_ps_demosecret123";
config.environment = "test";

SoundSync::ApiClient client(config);
client.verifyConnection("1.0.0", [](SoundSync::ApiResult result)
{
    // Runs on the JUCE message thread in the example client.
    // Do not unlock audio here; Test Connection only verifies product credentials.
    DBG(result.ok ? "SoundSync Test Connection passed" : result.code);
});