Site Refresh Process

 

If configured for your OU you can create clips from assets and get a download link.

Create a clipping order

API documentation: https://mgmtapidocs.emp.ebsd.ericsson.net/

The parts of the management API that are relevant for ordering clips is the clipping part of the API and in particular the endpoint /v1/customer/{customerUnit}/businessunit/{businessUnit}/clip/{assetId} .

To request a clip you send in a clipping order request to the ManagementAPI. If you have standard VODs you can simply send in two durations relative to the start of the asset and then a clip will be generated for you. You are also expected to provide an id for the request, a callback URL and can provide an optional boolean specifying if you want the generated clip to be audio only or not.

{
    "id":"4f79ad8a-9e53-4f86-bf31-4151b3d7e127",
    "startDuration":"PT1H2M43S",
    "endDuration":"PT1H4M43S",
    "callback":"https://www.example.com/callback",
    "audioOnly":false
}

The ID allows you to keep track of clipping orders on your end. When a clipping order is fullfilled and we have generated the file and download URL we will POST it to the specified callback URL The callback will look as follows if everything went well

{
  "orderId": "e28c3bd1-ef6e-4f1f-b2f2-63e624030774",
  "requestId" : "4f79ad8a-9e53-4f86-bf31-4151b3d7e127",
  "assetId" : "theAssetIdYouSpecifiedInThePath",
  "duration" : "PT2M",
  "downloadLink" : "https://cdnHost/clip/filename.mp4?sig=downloadToken",
  "fileSize" : 4152395,
  "expiration" : "2021-05-28T15:05:48.442392Z", 
  "status" : "DONE"
}

The requestId in the callback is the ID you specified in the body of the original request, the assetId is the id specified in the path when making the request. Duration is simply the duration of the generated clip and fileSize is the size of the generated clip in bytes. The downloadLink is where you can find the clip and expiration is the date until which the downloadLink is valid. Once the expiration date is reached the clip will be automatically purged and no longer available for download.