This is the documentation to the firebase rules, how data can be read & write in Radio4000's firebase.
Right now, the Radio4000 API consists of several parts: a Firebase database as well as a node.js API.
Disclaimer: we welcome anyone to use the available data, and to help improve the ecosystem. Only use this API in ways that respect users' privacy, does not harm the systems or steps out legality.
In this repository you can find:
Thanks to Firebase, the Radio4000 data can be accessed with classic REST as well as realtime through the Firebase SDK. The Firebase documentation explains how you can access data for various platforms: Web, Android, iOS, C++, Unity. This API supports GET HTTP methods. There is no versioning for this API as we have to follow and replicate any changes made at the Firebase level. Note that Firebase stores arrays as objects where the key of each object is the id of the model.
The Firebase security rules can be found in database.rules.json. This is the most precise definition of what can and should be done with the API. Most endpoints can be read without authentication. Reading a user, a userSettings or writing to (some) models always require authentication. For now, think of the API as read-only.
To deploy the rules see deployment.
Here's a list of available REST endpoints. They are all available via normal GET HTTP requests.
List of endpoints at https://radio4000.firebaseio.com.
For realtime database access, you should refer to the Firebase SDK available for your platform.
| URL | Description |
|---|---|
| https://radio4000.firebaseio.com/users/{id}.json | All users |
| https://radio4000.firebaseio.com/userSettings/{id}.json | Single user setting |
| https://radio4000.firebaseio.com/channels.json | All channels |
| https://radio4000.firebaseio.com/channels/{id}.json | Single channels |
| https://radio4000.firebaseio.com/channelPublics/{id}.json | All channel publics |
| https://radio4000.firebaseio.com/tracks.json | All tracks from all channels |
| https://radio4000.firebaseio.com/tracks/{id}.json | Single track |
You can see some example usage here https://github.com/internet4000/radio4000-player/blob/master/src/utils/store.js
Listed below are all available models and their properties. Also see this folder https://github.com/internet4000/radio4000/tree/master/app/models.
Requires authentication to read and write.
| name | type | description |
|---|---|---|
| channels | hasMany |
list of radio channels belonging to a user. We only allow one, for now. Example: {"-KYJykyCl6nIJi6YIuBO": true} |
| created | integer |
timestamp from when the user was created. Example: 1481041965335 |
| settings | belongsTo |
relationship to a userSetting model. Example: -KYJyixLTbITr103hovZ |
Requires authentication to read and write.
| name | type | description |
|---|---|---|
| user | belongsTo |
Relationship to a single user model. Example: "fAE1TRvTctbK4bEra3GnQdBFcqj2" |
Requires authentication to write.
| name | type | description |
|---|---|---|
| body | string |
description of the radio channel. Example: "The channel of your wet dreams..." |
| channelPublic | belongsTo |
relationship to a channelPublic. Example: "-JoJm13j3aGTWCT_Zbir" |
| created | integer |
timestamp describing when was this radio channel created. Example: "1411213745028" |
| favoriteChannels | hasMany |
list of channels this radio has added as favorite. Example: "-JXHtCxC9Ew-Ilck6iZ8": true |
| image | string |
the id for the cloudinary image model. Example: "image": "drz0qs9lgscyfdztr17t". See Image section for more info |
| isFeatured | boolean |
whether this channel is featured on Radio4000's homepage. Example: false |
| link | string |
Custom URL describing the external homepage for a radio channel. Example: "https://example.com" |
| slug | string |
the unique URL representing this channel. Used for human readable urls radio4000.com/pirate-radio). Example: "pirate-radio" |
| title | string |
title representing a radio channel. Example: "Radio Oskar" |
| tracks | hasMany |
list of track models. Example: {"-J_GkkhzfbefhHMqV5qi": true, ...} |
| updated | integer |
timestamp when the radio was last updated. Example: 1498137205047 |
channelPublic is a model always associated to a channel model. It is used so any authenticated user can associate data to a channel, when a channel can only be written by its owner. For exemple, adding a radio as follower will be done on the channelPublic model.
| name | type | description |
|---|---|---|
| channel | belongsTo |
relationship to a channel model. Example: "-JYEosmvT82Ju0vcSHVP" |
| followers | hasMany |
list of channel models following this radio. Example: {"-JXHtCxC9Ew-Ilck6iZ8": true, ...} |
| name | type | description |
|---|---|---|
| body | string |
optional description to the track. Example: "Post-Punk from USA (NY)" |
| channel | belongsTo |
relationship to channel model |
| created | integer |
date timestamp from when the model is created |
| title | string |
required title of the track. Example: "Lydia Lunch - This Side of Nowhere (1982)" |
| url | string |
the URL pointing to the provider serving the track media (YouTube only). Example: "https://www.youtube.com/watch?v=5R5bETC_wvA" |
| ytid | string |
provider id of a track media (YouTube only). Example: "5R5bETC_wvA" |
| mediaNotAvailable | boolean |
is the current track media available, accessible to be consumed |
| discogsUrl | string |
the URL pointing to the Discogs release (or master) corresponding to this track media. Example: "https://www.discogs.com/Nu-Guinea-Nuova-Napoli/master/1334042" |
For simplicity and focus of usages, a radio can only have one image.
In attent of a better solution, images are hosted at Cloudinary.
let width = 500,
height = 500,
quality = 100,
id = 'drz0qs9lgscyfdztr17t';
let base = `https://res.cloudinary.com/radio4000/image/upload/w_${width},h_${height},c_thumb,q_${quality}`;
let image = `${base},fl_awebp/${id}.webp`;The whole API is described in details on the Cloudinary documentation.
You can check how Radio4000 uses it.
The master branch will automatically deploy to staging. And production branch to production.
Also see the .travis.yml file.
To deploy manually, do this:
yarn global add firebase-toolsfirebase login
Deploying to staging
yarn deploy-rules && yarn deploy-api- Visit https://us-central1-radio4000-staging.cloudfunctions.net/api/
Deploying to production
yarn deploy-rules-production && yarn deploy-api-production- Visit https://api.radio4000.com/
Why Firebase? Firebase allowed this project to come to life without having the need to spend time building and maintaining backend software. It also allows us to be more secure we think we could be on our own, handling the storage and protection of user's sensitive data. In a perfect world we would like to have a backend that we fully control, running only free and open source softwares. The future will be great.
Which projects use the Radio4000 API?
- radio4000.com: the main website use this exact API via the JavaScript SDK.
- radio4000-player: the media player used by radio4000.com is a vue.js project communicating with this API via REST.
- mix.radio4000.com: mix radio4000 channels together
Do you want your project to appear here? Send a pull request or get in touch.