RESTful APIs for our Audio Streaming App

Since March 15, 2016 we’ve released 5 alpha versions of your RESTful APIs for our audio streaming app which also includes an audio meta data indexer.

The audio-streaming-apis repository maintains all the REST APIs used by the mobile app from the audio-streaming-app repository.

The server is build with Node.js using the Restify framework and backended with MongoDB. Node.js is a JavaScript runtime built on Chrome’s V8 JavaScript engine. Node.js uses an event-driven, non-blocking I/O model that makes it lightweight and efficient. Restify is a Node.js module to build REST web services. MongoDB is a popular NoSQL database often used with Node.js and has a strong Node.js driver.

The API endpoints provided are completely stand alone. They can be attached to and used to manipulate the database by any client including CURL.

Currently the endpoints service the Ionic audio-streaming-app found on GitHub. The app can be downloaded on the App (currently only through TestFlight) and Play Stores.

Here’s an overview of the release notes.

v1.0.0-alpha.1 (2016-03-15)

Initial alpha release. Endpoints for db collections (ACCOUNTS, PLAYLISTS, MP3S, LOGS).

CURL

All endpoints can be executed using CURL see the documentation for instructions.

Missing

  • Ratings
  • Facebook integration

v1.0.0-alpha.2 (2016-03-29)

Missing

Ratings
Facebook integration

Changes

  • Added dynamic port assignemnt
  • New endpoint GET /mp3s/key/:key
  • Temp patch for invalid artist ID3 tag
  • Jingles indexer and endpoint GET /jingle/random

v1.0.0-alpha.3 (2016-03-30)

Changes

  • GET /mp3s/distinctkey/:key
  • GET /mp3s/key/:key?q=
  • All mp3s endpoints work with and without auth, auth required to access restricted MP3s
  • New restricted key for mp3s collection

Issues

  • Artist tag in jingles generates error in ID3 parser
  • Some MP3 files have tag ID3 tag issues

v1.0.0-alpha.4 (2016-04-19)

Changes

  • POST /mp3s/ids endpoint
  • Added CORS support

Issues

  • Artist tag in jingles generates error in ID3 parser, now logged to db.log for intervention
  • Some MP3 files have tag ID3 tag issues
  • Uncaughtexception now logs to db.logs

v1.0.0-alpha.5 (2016-05-14)

Changes

  • Added POST /mp3/file/:id endpoint – to directly download MP3 file
  • Added new key for selfLink – this is a virtual link tot he google storage for MP3 playback

Issues

  • Artist tag in jingles may generate error in ID3 parser, now logged to db.log for intervention
  • Some MP3 files have tag ID3 tag issues, now logged to db.log for intervention

 

Leave a Reply

Your email address will not be published. Required fields are marked *