Versions Compared
| Version | Old Version 4 | New Version 5 |
|---|---|---|
| Changes made by | Former user |
Former user |
| Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Introduction
This section describes BSS communication with AminoTV Channels v4 API.
Authentication and authorisation
All BSS endpoints support API key authorization. The header named 'Authorization' with content "Apikey PUT_YOUR_KEY_HERE" must be passed with request.
In addition to API key authorization some clients can have IP white listing feature enabled, which will allow access only from exact IP's.
Both API key and IP addresses allowed list are customer specific data and you should contact support person to obtain those.
Endpoints overview
Endpoint | HTTP method | Purpose |
|---|---|---|
| /api/channel/management/v4/channels | GET | Get an index of channels. |
| /api/channel/management/v4/channels | POST | Create new channel |
| /api/channel/management/v4/channels/{channel_id} | GET | Get channel specified by id |
| /api/channel/management/v4/channels/{channel_id} | PATCH | Update channel specified by id |
| /api/channel/management/v4/channels/{channel_id} | DELETE | Delete channel specified by id and all related data |
Entities
ChannelResource
Up-to-date resource schema could be found on API documentation page Management Channel API v4 under schemas section.
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"data": [
{
"id": "42",
"type": "Channel",
"attributes": {
"name": [
{
"lang": "eng",
"value": "English string"
}
],
"description": [
{
"lang": "eng",
"value": "English string"
}
],
"images": [
{
"image_type": "Thumbnail",
"alternate_access_description": "Bruce Willis shooting a big gun at some bad guys, pew pew pew",
"width_pixels": 320,
"height_pixels": 200,
"iso_639-2_lang": "fin",
"url": "https://www.demo.com/assets/img/thumbnails/movies/diehard.png"
}
],
"channel_number": {
"default": 1
},
"media_type": "video",
"enabled_services": [
{
"type": "Live",
"startover": false,
"pause": false,
"trickplay": false,
"restrictions": {
"out_of_home": false
}
},
{
"type": "Catchup",
"boundary_offset": 360,
"trickplay": false,
"restrictions": {
"out_of_home": true
}
},
{
"type": "nPVR",
"retention_time": 30,
"watch_ongoing": false,
"boundary_offset": 360,
"trickplay": false,
"restrictions": {
"out_of_home": true
}
}
],
"restrictions": {
"geoblocking": true
},
"channel_domains": [],
"visibility": {
"start": 1605090698,
"end": 1605095698
},
"dvb_info": [
{
"type": "C",
"onid": 123,
"tsid": 123,
"sid": 4324,
"quality": "SD"
}
],
"metadata_provider_information": [
{
"provider": "ERICSSON",
"external_id": "724693092"
}
]
}
}
]
} |
Name and descriptions concept
Images concept
Domains concept
Use cases
Fetch channels
Get all channels
By calling Get an index of channels endpoint client could get paginated list of all existing channels. The default pagination limit is 100 items per page.
Get one channel
By calling Get channel endpoint client could obtain concrete channel data.
Create channel
By calling Create channel endpoint client could create new channel.
Create channel with required values
example request
list default values
Create channel with all fulfilled values
example request
Multiple descriptions, names, channel numbers, domains
Multiple images
Update channel
Delete channel
Multiple channel operators behaviour
Migration guide
Known issues and limitations
| Info |
|---|
Info level limitation example |
| Warning |
|---|
Warning level limitation example |
Postman collection
Table of Contents
| Table of Contents |
|---|
Child Pages
| Child pages (Children Display) |
|---|