/
Clipping V4 API

Clipping V4 API

Owned by Naveen Hosaagrahara Srinivas (Unlicensed)
Last updated: Aug 19, 2022

Introduction

This section describes BSS communication with /wiki/spaces/MAPI/pages/49677460

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.

Endpoints overview

Endpoint

HTTP method

Purpose

/api/clipping/v4/clipsPOSTCreate a new clip
/api/clipping/v4/clips/{clip_id}GETGet clip by id
/api/clipping/v4/clips/{clip_id}PATCHUpdate clip by id
/api/clipping/v4/clips/{clip_id}DELETEDelete clip by id

Entities 

Clipping Resource

Up-to-date resource schema could be found on API documentation page /wiki/spaces/MAPI/pages/49677460 under schemas section.

ClippingResource example 
{
  "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

/wiki/spaces/MAPI/pages/49677460

Postman collection


Related content