Introduction
...
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 specific 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/clipping/v4/clips | POST | Create a new clip |
| /api/clipping/v4/clips/{clip_id} | GET | Get clip by id |
| /api/clipping/v4/clips/{clip_id} | PATCH | Update clip by id |
| /api/clipping/v4/clips/{clip_id} | DELETE | Delete clip by id |
Entities
Clipping Resource
...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"data": {
"id": "123abc",
"type": "Clip",
"attributes": {
"channel_id": "123abc",
"start_time": 1523268698,
"end_time": 1523268698,
"provider_showing_id": "abc123"
}
}
} |
Attributes
- channel_id: Channel id of the clip
- start_time: start time of the clip
- end_time: end time of the clip
- provider_showing_id: should be the unique id that we match with our Epg, broadcast_slots for catchup and recordigns
Use cases
Clipping API to fetch, create, update and delete Clip
...