Skip to main content

Overview

Introduction​

The Music API is a RESTful service that lets you build your own integration for Stingray Music. With the APIs, you can offer consistent player functionality and continuous access to the Stingray Music catalog.

This online documentation provides a step-by-step process on how to utilize the Stingray Music API, accessible at https://music-service.stingray.com/api/v2.

Please note that accessing the API requires a JSON Web Token (JWT) which can be obtained from the authentication API at https://login.stingray.com. See the Getting Started section for more information.

Documentation​

Our documentation website is a comprehensive resource designed to help you understand and effectively use our products and services. Below, you will find a brief overview of each section available on the website, ensuring you can quickly find the information you need.

Getting Started​

The Getting Started section is your first step into our world. It's crafted to help new users familiarize themselves with our system. Here's what you can expect:

  • Authorization Guides: Step-by-step instructions on how to authorize your request for the API.
  • Basic Operations: Simple tutorials that walk you through the basic functionalities of our products.

General Information​

In the General Information section, you'll find a wealth of knowledge about our products and services:

Concept​

The concept section is your go-to for understanding the specific terminology used throughout our documentation and products:

  • Token: Explanation of the API authorization token
  • HLS: Quick summary of HTTP live streaming (HLS) and its usage in the API.
  • Station: What's a station in the API.
  • Podcast: What's a podcast in the API.
  • Audiobook: What's an audiobook in the API.
  • Filters: What are filters and how they are used in the API.
  • Template: Explanation of the templating feature of the API.

Tutorials​

Our Tutorials section is designed to provide hands-on, practical guidance:

  • Browsing & Searching: Tutorials about the browsing and search functionality of the API.
  • Playing a Resource: Tutorials on how to play a station, podcast or audiobook and their relative features.
  • Using Profile: Tutorials on the profile utilisation with the API.
  • Using Template: Tutorial about the templating functionality of the API.
  • Metadata Tags: Tutorials on the usage of the HLS metadata tags for the stations.

Client Libraries​

In the Client Libraries section, developers can find resources to integrate our services into their applications