music-api-service-test.stingray.com
Open in
urlscan Pro
54.243.110.155
Public Scan
Submitted URL: https://music-api-service-test.stingray.com/
Effective URL: https://music-api-service-test.stingray.com/swagger-ui.html
Submission: On September 04 via automatic, source certstream-suspicious
Effective URL: https://music-api-service-test.stingray.com/swagger-ui.html
Submission: On September 04 via automatic, source certstream-suspicious
Form analysis 1 forms found in the DOM
<form class="download-url-wrapper"><label class="select-label" for="select"><span>Select a spec</span><select id="select">
<option value="https://music-api-service-test.stingray.com/v2/api-docs?group=v1">v1</option>
</select></label></form>Text Content
swagger
Select a specv1
MUSIC-API
[ Base URL: music-api-service-test.stingray.com/ ]
https://music-api-service-test.stingray.com/v2/api-docs?group=v1
This documentation will guide you in the development of an interactive music
application using the Stingray Music API.
If you have questions, comments or other feedback regarding the API or
documentation, please contact us
by email at support@stingray.com.
SERVICE ACCESS
You are initially provided with an API key from Stingray to access this service.
This key must be specified in the
x-client-id header of all requests in order to authenticate the source.
CORS (Cross-Origin Resource Sharing) is disabled on this service for security
purposes.
HEADERS
The following headers are mandatory for each request in this service
* X-Language - Language in which you want your results to be returned.
* X-Device-Id - Unique identifier of the device issuing the requests to this
service.
GLOSSARY
* branding - Stingray logos to be displayed on your client interface.
* channel - Music station with content selected by Stingray curators.
* playlist - List of songs generated for a given channel.
* swimlane - Editorial list of channels, artists, tags or special features.
* tag - Channel genre, such as pop, rock, metal, etc.
* track - Playable asset, such as a song or a commercial.
BRANDING
* Get all branding images - Returns the list of all available branding images.
* Get specific branding image - Returns a link to the branding image with the
specified ID.
* If only one of width or height is specified, that image’s attribute will be
set to the given value and the other
will be set such that the image’s aspect ratio is preserved. Otherwise, the
image will be resized to both specified
values.
* This request will not work in swagger. It must be called from an external
source due to CORS policy
* Stingray will provide you with the IDs of the images to display on your
application.
CHANNELS
* Get channels - Returns a list of available Stingray channels.
* As the number of channels returned may be quite large, it is advisable to
use this call sparingly.
* Get a specific channel - Returns a single channel corresponding to the
specified identifier.
* with_channel_info - If this flag is set to true, the call returns
additional channel information consisting of
the curators’ data (names, influences, interests, etc.), top songs, related
channels and related artists. If the flag
is set to false (default), only the channel’s name, description and cover
image are returned.
* Search - Search for channels corresponding to the provided search parameters.
* The search produces results containing (partial match) all the specified
parameters, namely channel_name,
artist_name and tag_name. A blank search string for any of these parameters
will match all channels. For example,
specifying an artist name only will return all channels featuring artists
whose name contain the given search string.
Specifying a channel and artist name will restrict this list to channels
whose names contain the given search string.
In both cases, a blank tag name will match all available tags. Specifying a
tag will further constrain the results to
channels containing the specified tag.
* Returned channel lists are paginated according to the following parameters:
* page_size - Number of channels per result page (minimum 1, maximum 100,
default 20).
* start_index - Starting element index of search results (zero-based).
HLS
* Create - Returns an HLS stream URL.
* The following parameter is required to create an HLS stream:
* channel_id - ID of the channel from which the playlist is generated.
* To listen to the HLS stream, the URL must be opened in an HLS player.
* Skip - Skips the currently playing song in a previously created HLS stream.
* The following parameter is required to skip a song in an HLS stream:
* playlist_id - ID of the playlist associated with the HLS stream.
* The endpoint returns the URL of the HLS stream starting after the skipped
song. This URL must be opened in
an HLS player to resume playback after the skip.
LOGS
* Log song played - Log the duration of a played song. This must be called for
every played asset individually.
* IMPORTANT - You are contractually bound to report the actual played duration
of all songs. This ensures artists
are properly compensated for their work.
PLAYLISTS
* Create a new playlist - Creates a new playlist for the user or device calling
this endpoint.
* The following parameters are required to create a playlist:
* channel_id - ID of the channel from which the playlist is generated.
* quality - Quality of the audio. There are 3 available qualities:
* normal - 96 Kbps MP4 AAC
* high - 160 Kbps MP4 AAC
* ultra - 320 Kbps MP4 AAC
* size - Number of items in the playlist to be created (minimum 1, maximum
10, default 5).
* Get more items in a playlist - Gets more items for a previously created
playlist.
* Specify the playlist ID of a previously created playlist to retrieve more
songs for this playlist.
* Get a track in a playlist - Return a link to a song to be played for a given
playlist ID.
* The track ID is obtained from the playlist returned by either of the two
preceding endpoints.
* The track must be associated with a valid playlist ID (obtained at playlist
creation).
* The song links expire 24 hours after they are generated.
* This request will not work in swagger. It must be called from an external
source due to CORS policy
* Generated playlists remain cached as long as they are accessed. If no further
items are fetched for a playlist for a
period of 6 hours, the playlist is removed from the cache and a new one must
be created.
Note that generated playlists are cached for 6 hours.
* The following steps describe a typical playlist call flow:
1. Get the list of channels.
2. Get the channel info for a selected channel if needed.
3. Create a playlist for the selected channel.
4. Play the tracks from the playlist, logging the played duration of each
track (see Logs below).
5. Get more items in the playlist.
6. Repeat steps 4 to 6 until playback is stopped.
SWIMLANES
* Get swimlanes - Returns a list of suggested swimlanes.
* Swimlane contents are constantly updated by Stingray curators. The
available list of swimlanes is actually fairly
large, but this endpoint returns the ones that are most commonly used and
updated. The typical lineup consists of the
following swimlanes:
* Top Channels - A list of the most popular channels.
* Browse All - A list of all available channel tags.
* New Channels - A list of newly added channels.
* The content of a swimlane consists of a list of channels or channel tags.
* Get a specific swimlane - Returns the contents (channels or tags) of the
swimlane with the specified ID.
TAGS
* Get tags - Returns a list of all tags with their child tags.
* An optional parameter tag_code may be specify to fetch a list of specific
tags
* ?tag_code=POP&tag_code=CLASSICAL&level=3
* Get tag by code - Retrieve tag information for a given tag
* An optional parameter level may be specified when fetching tags. Possible
values are:
1 = root tag (default)
2 = root tag + children
3 = root tag + children + children of children
ERRORS
When retrying a call following an error, avoid retrying indefinitely for
performance and availability reasons.
© 2020 Stingray Digital Media Group. All rights reserved. STINGRAY® and other
related marks and logos are
trademarks of Stingray Digital Media Group in Canada, the United States of
America and/or other territories.
Terms of service
Stingray Support - Website
Send email to Stingray Support
Schemeshttps
Authorize
BRANDING-CONTROLLER
PROVIDES ACCESS TO STINGRAY BRANDING IMAGES.
CHANNEL-CONTROLLER
PROVIDES INFORMATION ON CHANNELS AVAILABLE TO YOUR ACCOUNT.
FAVORITE-CONTROLLER
FAVORITE-CONTROLLER
HLS-CONTROLLER
PROVIDES HLS STREAMS AND FUNCTIONS.
LOG-CONTROLLER
PROVIDES ACCESS TO LOGGING FUNCTIONS.
PLAYLIST-CONTROLLER
PLAYLIST CREATION AND ACCESS FUNCTIONS.
PROFILE-CONTROLLER
PROFILE-CONTROLLER
SWIMLANE-CONTROLLER
PROVIDES ACCESS TO SWIMLANES AVAILABLE TO YOUR ACCOUNT.
TAG-CONTROLLER
PROVIDES ACCESS TO CHANNEL TAGS.
MODELS