Quickstart

Outcome
Prove end-to-end value: Retrieve user details, search a track, stream a track, and log the play

Step you will complete
Auth → Retrieve user profile → Search the catalogue → Retrieve metadata → Stream track → Log playback

Timed required
~10-15 minutes
Prereqs (before you start)
- Test user account (to own the playlist and play events)
Step-by-step
1
Authenticate
Request a JWT from our auth server by providing the username and password of a pre-registered user. See how to get Test key and teast user account from Tuned Global here.
Why: This logs the user into our system.
Example:
curl --location 'https://api-authentication-connect.tunedglobal.com/oauth2/token' --header 'StoreId: XXYY' --header 'Content-Type: application/x-www-form-urlencoded' --data-urlencode 'grant_type=password' --data-urlencode 'username=testUserName' --data-urlencode 'testPassword
2
Retrieve the user profile
Start by fetching the current user’s account subscriptions, and device details
Why: This determines the user’s access rights and playback restrictions before you proceed with catalogue or streaming actions.
Example:
curl --location 'https://api-services-connect.tunedglobal.com/api/v3/users/{user_id}/profile' --header 'StoreID: XXYY' --header 'Authorization: Bearer xxxyyyy
Returns:
- Active subscriptions
- Registered devices
- Basic user profile information
3
Search the catalogue
Use Tuned Global’s flexible search endpoints to find a track. You can search by:
Choose the search endpoint most suited to your UI or workflow
Why: This mirrors real discovery behaviour and helps you test how your application will surface music to users.
Example:
curl --location 'https://api-metadata-connect.tunedglobal.com/api/v2/search/songs?q=Bohemian%20Rhapsody' --header 'StoreId: XXYY'
4
Retrieve catalogue metadata
Once you select a track, retrieve detailed metadata to support your UI and playback logic.
Why: Metadata and optimised images are essential for any modern music UI and ensure fast performance.
Track Metadata
- Returns: Track name, artist name, duration, metadata fields, etc.
Album Metadata
- Returns: Album title, artist, album art, release metadata.
Artist Metadata
- Returns: Artist name, image
Image handling
Use the Image Engine (Thumbor) to generate correctly sized artwork for your UI. Raw images are often too large and will impact your service performance.
5
Stream a track
Request a streaming URL for your selected track and device
Why: This validates playback wiring, entitlements, and device-level rights enforcement.
Inputs:
- Tuned Global Track ID
- Device ID (Provided by Tuned Global with your test key and account)
This returns a signed streaming URL which your player can use for playback.
Example:
curl --location --request POST 'https://api-services-connect.tunedglobal.com/api/v3/plays/{trackId}/{device}/stream?streamType=Music&streamProvider=Tuned' --header 'StoreID: XXYY' --header 'Authorization: Bearer xxxyyyy'
6
Log playback activity
Send playback events for reporting, licensing and analytics.
Why: Accurate play logs power royalty reporting and help you understand user behaviour.
Example:
curl -X POST "https://api-services-connect.tunedglobal.com/api/v3/plays/222" -H "Content-Type: application/json" -H "Accept: application/json" -d '{ "TrackId": {trackId}, "LogPlayType": "Start", "Seconds": 30, "Source": "Album", "SourceId": {albumId}, "Guid": "ao2n-d3fw-dd5v-ddx3", "Country": "AU", "PlayerType": "MobilePhone"}'
Recommended logging events:
- Start of Play
- 30-second point (mandatory for reporting)
- Skip event (include the timestamp at the moment of skip)
- End of File
What you should see or hear
- You can press Play and hear audio.
- A play record appears in your history/logs.
- A playlist exists with your test track.
- 200 responses with expected payloads in Postman.
- Playback URL with a valid expiry (TTL).
- Play log entries for the test user and track.
Common errors & Troubleshooting
- 403 on playback → Token expired or user not entitled. Re-authenticate; check subscription/package.
- No play logged → Verify timestamps, user ID, and duration threshold.
- Playlist empty → Check track ID scope and user permissions; retry add-item.
What made this section unhelpful for you?
On this page
- Quickstart