logo
logo

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Get News & Updates

OrbixPlay API

Insert & Delete Playlists

OrbixPlay provides simple and secure REST APIs to add or delete playlists on registered devices. Below you will find the full documentation including endpoints, headers, request body, fields, and responses.

1. Add Playlist API

Adds a new playlist for a specific device.

Endpoint

POST https://apis.orbixplay.com/add-playlist

Headers

  • Content-Type: application/json
  • x-customer-key: <your-customer-key>

Request Body

{
  "query": {
    "deviceid": "<device-id>",
    "playlistName": "<playlist-name>",
    "username": "<username>",
    "password": "<password>",
    "host": "<host-url-or-code>"
  }
}

Fields

  • deviceid: Unique identifier of the device (must exist in the database).
  • playlistName: Playlist name.
  • username: Username associated with the playlist.
  • password: Password associated with the playlist.
  • host (string or integer): if string, considered a URL; if integer, considered a host_code and will be added to the playlist document.

Response

  • Success: 200 OK
  • Error: 400 Bad Request if deviceid or x-customer-key is invalid.

2. Delete Playlist API

Deletes all playlists matching the provided deviceid and customer key.

Endpoint

POST https://apis.orbixplay.com/delete-playlists

Headers

  • Content-Type: application/json
  • x-customer-key: <your-customer-key>

Request Body

{
  "query": {
    "deviceid": "<device-id>"
  }
}

Response

  • Success: 200 OK
  • Error: 400 Bad Request if deviceid or x-customer-key is invalid.

Notes

  • The deviceid must already exist in the database.
  • The customer key must be valid to perform actions.
  • External users' customer keys and related data are stored in a separate collection to filter playlists per customer.
Telegram