api:iptv:app:start
API : IPTV : APP
This is the API calls used by the iOS and Android apps and by the Web clients.
| Auth endpoints - used to login/logout, etc. | |
|---|---|
| Login | Login and claim a streaming license for the device. |
| Validate | Check if session key is still valid. |
| Logout | Logout and expire the token. |
| Un-register | Release the DRM license and remove the device. |
| Reserve Code | Called by TV device to register a login code. |
| Login by code | Login using a code from a TV device. |
| Login by proxy | Login using another device. |
| Login by serial | Login using serial number on a tablet |
| Login by device ID | Login using device ID/barcode on a tablet |
| Branding endpoints - used for reseller branding | |
| Branding (logo) | Fetch resellers logo for branding the app. |
| Branding settings | Fetch branding settings. IPTV private only. |
| TV channel endpoints | |
| Channel list | List of available TV channels with EPG for now and next. |
| Channel play | Get URL for streaming the channel. |
| Channel start over | Get URL for re-starting the current program. |
| Channel play from time | Get URL for playing the current channel from a point in time. |
| Channel stop | Report playback stop. |
| TV archive endpoints | |
| Archive list | List of archived programs, available for playback. |
| Archive get | Get details for an archived program. |
| Archive play | Report start of playback of archived program. |
| Archive stop | Report stop of playback of archived program. |
| TV recording endpoints | |
| Recordings list | List of programs the customer has recorded. |
| Recording get | Get details for a recorded program. |
| Recording play | Report playback start for recorded program. |
| Recording stop | Report playback stop for recorded program. |
| Recording schedule | Schedule a program for recording. |
| Recording delete | Delete a recorded program or a scheduled recording. |
| Recording favorite | Mark a program as a favorite recording. |
| Recording update | Update a customer's recording. |
| Misc app endpoints | |
| Status | Report playback status. |
| Device list | List of devices the customer has registered. |
| Device name | Set the name of a device. |
| Device delete | Release the DRM license and remove a device, other than the device it self. |
| Account | Change account credentials. |
| Radio channels | List of radio channels. |
| Radio channel logo | Get logo for radio channel. |
| EPG | Get EPG for single program. |
| EPG now | Get EPG for the program currently shown on a channel. |
| Multi EPG | Get EPG for multiple programs. |
| Log error events | Log error events. |
| Get launcher config | Get launcher config (Android tablet) |
| Heartbeat/Tablet events | Heartbeat for tablets. The tablets report info to Telecom X, and they get a list of actions to run (if any). |
| Get tablet profile | Get the tablet profile. |
| Programs - Endpoint used to search in programs (IPTV private) | |
| Programs | Search in all programs (IPTV private only) |
| Provision - API used by Android tablets | |
|---|---|
| App list | Gets list of apps that should be installed on a device. (Android tablet only) |
| App list update | Gets list of apps that should be updated on a device. (Android tablet only) |
| App whitelist - API used by Android tablets | |
| App whitelist APK | Gets an APK url for a specific app. (Android tablet only) |
| DRM account profile endpoints - used by IPTV private devices | |
| List | List of profiles for a DRM account. |
| Get | Get a profile for a DRM account. |
| Create | Create a profile for a DRM account. |
| Update | Update a profile on a DRM account. |
| Delete | Delete a profile from a DRM account. |
| Watchlist - used by DRM profiles (IPTV Private) | |
| List | List of programs on a profile's watch list |
| Create | Put a program on a profile's watch list |
| Delete | Remove a program from a profile watch list |
| Streaming services (IPTV Private) | |
| List | List of available streaming services. |
| Streaming (IPTV Private) | |
| Featured content | Lists featured content from archive and streaming services |
Token
Most app API's requires a token. It is created during login, and shall be used until the device logout or un-registers.
When calling the API, the token can be presented in 4 ways:
| Method | Description | Example |
|---|---|---|
| HTTP header | As an HTTP header | Authorization: Bearer <TOKEN> |
| Body | As a property in the JSON body on POST requests | { token: <TOKEN>, other-arg: 'value' } |
| Query | As an argument on the URL | ?a=b&token=<TOKEN> |
| Cookie | In a cookie | token=APP-<TOKEN> |
api/iptv/app/start.txt · Last modified: 2025/01/14 07:50 by Gudni Sigurdsson