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.

1111b South Governors Avenue STE 7336 Dover, DE 19904 US
[email protected]
Telegram
Telegram: @theplayerguy
Get News & Updates

OrbixPlay API

Playlists, Slots & List Codes

OrbixPlay provides simple and secure REST APIs for subscribers to manage playlists, check slot usage, and work with list codes. All endpoints require your customer key in the x-customer-key header.

Authentication

Every request must include your subscriber customer key. Only subscriber accounts can use these APIs.

  • Header: x-customer-key: <your-customer-key>
  • Header: Content-Type: application/json
  • Obtain your customer key from your OrbixPlay subscriber account or support team.

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>",
    "notes": "<optional-notes>"
  }
}

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.
  • notes (optional): Free-text notes stored on the playlist.

Response

  • Success: 200 OK — playlist inserted
  • 400 — missing required fields or invalid host format
  • 403 — subscription expired or slot limit reached
  • 404 — device not found or customer key not found
  • 500 — internal server error

2. Delete Playlists API

Deletes all playlists for the provided device.

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>"
  }
}

Fields

  • deviceid: Unique identifier of the device whose playlists should be deleted.

Response

  • Success: 200 OK — playlists deleted
  • 400 — missing required fields
  • 403 — not allowed for this key
  • 404 — device not found, no playlists to delete, or customer key not found
  • 500 — internal server error

3. Detect Slots API

Returns slot usage for the subscriber. The email in the body must match the owner of the customer key.

Endpoint

POST https://apis.orbixplay.com/detect-slots

Headers

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

Request Body

{
  "query": {
    "email": "<subscriber-email>"
  }
}

Fields

  • email: Subscriber email address (must match the account linked to the customer key).

Response

  • Success: 200 OK — returns email, role, total_slots, used_slots, remaining_slots
  • 400 — missing customer key or email
  • 403 — email does not match key owner or role is not subscriber
  • 404 — customer key not found
  • 500 — internal server error

4. Add List Code API

Registers a playlist source (DNS, username, password) and returns a listcode. Returns the same code if an identical source already exists for your account.

Endpoint

POST https://apis.orbixplay.com/add-list-code

Headers

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

Request Body

{
  "dns": "http://example.com:8080",
  "username": "<username>",
  "password": "<password>",
  "playlistName": "<playlist-name>"
}

Fields

  • dns: Server URL or host (with or without http://).
  • username: Playlist username.
  • password: Playlist password.
  • playlistName: Display name for the list code.

Response

  • Success: 200 OK — { listcode, status: "created" }
  • Success: 200 OK — { listcode, status: "already_exists" } (same subscriber + same credentials)
  • 400 — missing or invalid parameters
  • 401 — missing or invalid x-customer-key
  • 403 — forbidden (subscriber role required)
  • 500 — internal server error

5. Create Playlist from List Code API

Creates a playlist on a device using a listcode you own. Validates the device exists and enforces subscription slots.

Endpoint

POST https://apis.orbixplay.com/playlist-from-list-code

Headers

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

Request Body

{
  "listcode": 12345678,
  "deviceid": "<device-id>",
  "notes": "<optional-notes>"
}

Fields

  • listcode: Numeric list code returned by the Add List Code API.
  • deviceid: Target device identifier (must exist in the database).
  • notes (optional): Free-text notes stored on the playlist.

Response

  • Success: 201 Created — { status: "added", playlist_id }
  • 400 — missing required parameters
  • 401 — missing or invalid x-customer-key
  • 403 — forbidden, subscription expired, or slots exceeded
  • 404 — device not found or listcode not found for this key
  • 500 — internal server error

Notes

  • All endpoints are POST requests to https://apis.orbixplay.com/
  • The deviceid must already exist in the database before adding playlists.
  • The customer key must belong to a subscriber account.
  • List codes are scoped to your subscriber account — you cannot use another user's listcode.
Telegram