https://github.com/soundtrackyourbrand/soundtrack_api-example_app

Example app for Soundtrack API.
https://github.com/soundtrackyourbrand/soundtrack_api-example_app

soundtrack-api

Last synced: about 2 months ago
JSON representation

Example app for Soundtrack API.

• Host: GitHub
• URL: https://github.com/soundtrackyourbrand/soundtrack_api-example_app
• Owner: soundtrackyourbrand
• License: mit
• Created: 2018-12-12T07:15:33.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-10-31T09:15:26.000Z (about 1 year ago)
• Last Synced: 2023-10-31T10:28:02.957Z (about 1 year ago)
• Topics: soundtrack-api
• Language: JavaScript
• Homepage:
• Size: 3.93 MB
• Stars: 4
• Watchers: 8
• Forks: 1
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Soundtrack API | Example app

This is a sample app demonstrating how to implement against the Soundtrack API. The purpose of this app is to get you started, so for the sake of simplicity this is a frontend app.

Please note that you should not build an app where the secrets can be found in the source code. If we find secrets that are exposed, we will block these immediately. We suggest handling the code in a backend and then implement whatever authentication layer that your app needs.

## Prerequisites

* A Soundtrack subscription. Please see www.soundtrackyourbrand.com to sign up

* API credentials. Request them via [this page](https://api.soundtrackyourbrand.com/v2/docs)

* [nodejs](https://nodejs.org/en/download/) (**Note: node version >=10**) and [yarn](https://yarnpkg.com/lang/en/docs/install/)

## Terms of use

By using the Soundtrack API, you accept to our [Terms of use](https://www.soundtrackyourbrand.com/legal/api-terms-of-use).

## Documentation

* [API Documentation](https://api.soundtrackyourbrand.com/v2/docs)

* [API Explorer](https://api.soundtrackyourbrand.com/v2/explore)

## The app

The app displays your brands and their sound zones. You can see what is playing on each zone. Both the sound zone data and the now playing data will be updated over web sockets. You can also find paginated queries and how to setup subscriptions.

## Running the app

```

yarn

yarn run get-schema

yarn run relay # or to start a watcher: yarn run relay --watch

REACT_APP_API_CREDENTIALS=your_token yarn start

```