API reference
API Surfaces and Coverage
Distinguish integration APIs, authenticated management calls, provider callbacks and internal administration.
SoundSync
Choose the correct surface
| Surface | Audience and boundary |
|---|---|
| Product licensing and package clients | Product-scoped credentials or matching generated native public-client identity; customer and machine proof remains required. |
| External partner API /api/partner/v1 | Relationship-scoped server-to-server partner credentials, assigned products and idempotent order reporting. |
| Authenticated management references | First-party developer/customer account sessions, permissions and product assignments. Not an OAuth platform or a promise that every dashboard route is a stable external SDK. |
| Partner portal and relationship administration | Authenticated first-party workspace workflows. Use the Partner Hub guides; do not substitute these account-session routes for the external partner API. |
| Owner/admin/internal routes | Restricted operations, not public integration methods. Their existence is not general availability or permission to execute them. |
| Provider callbacks and verification links | Called by the configured provider or opened with a private one-use token. Never poll them as health checks or manufacture financial events. |
| Retired and compatibility aliases | Documented where needed for existing clients. Prefer the current canonical route; not every historic alias is a supported new integration. |
Coverage is not a live-provider guarantee
Every operation in the published catalog includes reviewed fields or an explicit file/HTML/redirect transport contract. This catalog is not a count of every mounted application route. Internal administration, provider callbacks and first-party-only portal routes are deliberately distinct from public integration APIs.
Examples are illustrative unless their fixture evidence is stated. Source review and synthetic tests do not verify every provider, renewal, refund, native host or operational procedure. Keep the workflow guide beside the endpoint contract and validate the actual response before granting access.
SoundSync
