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: integer (required)
• appId: string (required)
• pluginKey: string
• pluginSecret: string
• publicClient: hise-native | juce-native
• pluginVersion: string
• environment: string

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.

{
  "type": "object",
  "properties": {
    "productId": {
      "type": "integer",
      "minimum": 1
    },
    "appId": {
      "type": "string"
    },
    "pluginKey": {
      "type": "string"
    },
    "pluginSecret": {
      "type": "string"
    },
    "publicClient": {
      "enum": [
        "hise-native",
        "juce-native"
      ]
    },
    "pluginVersion": {
      "type": "string"
    },
    "environment": {
      "type": "string"
    }
  },
  "required": [
    "productId",
    "appId"
  ],
  "additionalProperties": true
}

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

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

SoundSync::CredentialConfig config;
config.apiBaseUrl = "https://www.soundsync.dev";
config.productId = "23794";
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);
});