Swagger
API Explorer
Using Swagger
This documentation presents the Tuned Global APIs as a single, unified API structure, combining Metadata and Services into one logical API Suite, alongside the Catalogue Feed (CDS).
However, when working with the APIs in practice, you will interact with separate Swagger interfaces for each API surface.
Swagger Endpoints
You will be provided with environment-specific URLs during onboarding.
- Metadata API (Swagger)
- Used for catalogue and content access (no user context)
- Services API (Swagger)
- Used for user, playback, and transactional functionality
- Catalogue Feed API (CDS) (Swagger)
- Used for catalogue ingestion, asset access, and external playback
While these are exposed as separate Swagger endpoints, they are designed to work together and are reflected as a single structure in this documentation.
Versioning
Each Swagger interface may contain multiple API versions.
- Always use the latest available version unless advised otherwise
- Older versions may remain for backward compatibility but can be deprecated over time
- Version selection is available directly within Swagger
Authentication in Swagger
Authentication varies by endpoint and API.
While common models include API Key or OAuth (Bearer Token), there are some specific use cases that utilise HMAC:
- Do not assume a single authentication method across all endpoints
- Always refer to the specific endpoint definition within Swagger or this documentation
- Required headers and authentication types are defined per endpoint
Best Practice
- Use Swagger to:
- Explore endpoints and parameters
- Validate request/response structures
- Confirm authentication requirements
- Treat Metadata + Services APIs as a single logical API Suite, even though they are accessed via separate Swagger interfaces
- Use Catalogue Feed (CDS) only where your architecture requires it and it has been provisioned by Tuned Global
Was this section helpful?
On this page
- Swagger