Using API to Publish Content

Introduction

The ViewLift CMS (VLCMS) Upload API allows you to programmatically upload and manage video content on the ViewLift platform. This guide provides detailed instructions on how to use the API, including required parameters, field descriptions, and example requests. The API enables you to streamline your content management workflow, ensuring efficient and automated video uploads with optional encoding, DRM settings, and metadata management.

Purpose

The purpose of the VLCMS Upload API is to facilitate the efficient and automated uploading of video content to the ViewLift platform. By using this API, you can:

• Upload video files directly to the ViewLift CMS.

• Automatically encode videos and manage DRM settings.

• Attach metadata, images, and additional assets to your videos.

• Schedule video publishing and visibility settings.

• Integrate video content management into your existing workflow and applications.

Prerequisites

Before using the VLCMS Upload API, ensure you have met the following prerequisites:

1. API Key: Obtain an API Key from the ViewLift CMS under Admin > SDK Management. You can generate up to 5 API Keys for your account.

2. ViewLift S3 Bucket Access: Ensure your source files are located in your dedicated ViewLift S3 bucket. Contact your account manager to set up access for sending assets to this bucket.

3. CURL Tool: Have the CURL command-line tool installed for making HTTP requests (alternatively, you can use any other HTTP client).

4. Metadata Information: Prepare all necessary metadata, including title, description, author details, and image URLs, to include in your upload requests.

5. Video File: Ensure your video file is correctly formatted and uploaded to the ViewLift S3 bucket.

Upload Request (with Encoding)

Follow these date formats when specifying airDateTime and seasonAirDateTime:

• airDateTime: "2023-10-22T23:00:00.000 PM”

• seasonAirDateTime: "07/26/2019 7:30 AM"

Include these keys in your JSON payload:

• drmEnabled: Boolean indicating if DRM is enabled.

• externalId: Unique identifier for assets migrated or created via the API.

• siteOwner: String representing the owner of the site.

• videoResolution: String specifying video resolution ("SD" or "HD").

Requirements

• When sending sourceKey, do not send videoAssets, and vice versa.

• Always include videoImageUrl when using this API.

Recommendations

• If posterImageUrl is unavailable, ignore it rather than passing null.

• For schedule times not required up to year 2080, omit scheduleStartTime, scheduleEndTime, scheduleStartDate, scheduleEndDate.

• When declaring schedule start and end times, include timezone.

• If categories, tags, or closed captions aren't available, pass an empty array.

Sample JSON

jsonCopy code{
    "site": "abc-tv",
    "siteOwner": "abctv",
    "title": "The TV Show's TV Show",
    "description": "ABC's Insights: The TV Show",
    "drmEnabled": false,
    "status": "open",
    "fileName": "TVshowname-2023-10-22T18-00.mp4",
    "sourceKey": "s3://boost-abc-tv/MezzFiles/archive/2023/10/TV show name-2023-10-22T18-00.mp4",
    "author": "BEK",
    "email": "xyzabc@gmail.com",
    "videoImageUrl": "http://v-abc-tv.viewlift.com/MezzFiles/images/2023/10/TV show name-2023-10-22T18-00.png",
    "airDateTime": "2023-10-22T23:00:00.000",
    "seasonAirDateTime": "8/8/2019 5:00 AM",
    "airTimezone": "US/Eastern",
    "seasonAirTimezone": "US/Eastern",
    "year": 2019,
    "thirdParty": "abc-tv",
    "objectKey": "video",
    "isTrailer": false,
    "isLiveStream": false,
    "free": false,
    "licenses": [],
    "scheduleEndDate": "1/1/2080",
    "scheduleEndTime": "12:00 PM",
    "scheduleStartDate": "8/8/2019",
    "scheduleStartTime": "12:00 AM",
    "timezone": "US/Eastern",
    "externalId": "3bc82664-0eda-4442-a8b6-682c36349254"
}

Upload Request (without Encoding)

For uploading content with pre-existing renditions, use the following format:

API Endpoint: https://tools.viewlift.com/vlcms/video/uploadAndPublish Method: POST Headers: xApiKey Body:

jsonCopy code{
    "site": "<site-value>",
    "author": "<author name>",
    "description": "<Description of the Video>",
    "drmEnabled": false,
    "email": "<email of the author>",
    "status": "open",
    "filename": "<samplefilename.mp4>",
    "isLiveStream": false,
    "free": false,
    "fileSize": 26,
    "videoImageUrl": "https://cdn.com/asset.jpg",
    "posterImageUrl": "https://cdn.com/asset.jpg",
    "title": "<Video Title>",
    "airDateTime": "2019-07-11T14:36:00Z",
    "airTimezone": "US/Eastern",
    "year": 2018,
    "thirdParty": "draft-kings",
    "objectKey": "video",
    "isActive": false,
    "isArchivedDate": false,
    "isCurrent": true,
    "isPublishDate": true,
    "isTrailer": false,
    "isTranslated": false,
    "isUpdateDate": true,
    "isUpdated": false,
    "isVisible": true,
    "licenses": [
        {
            "id": "28733590-8e8e-11e9-8182-d18c0906e027",
            "title": "India License"
        }
    ],
    "pricingOverrides": {},
    "scheduleEndDate": "2019-07-10T00:00:00Z",
    "scheduleEndTime": "4:44 PM",
    "scheduleStartDate": "2019-07-10T00:00:00Z",
    "scheduleStartTime": "2:40 PM",
    "seasonAirDateTime": "2019-07-10T14:35:00Z",
    "seasonAirTimezone": "US/Eastern",
    "languageCode": "default",
    "runtime": "30 (runtime in seconds)",
    "videoAssets": {
        "mpeg": [
            {
                "bitrate": 925,
                "codec": "H264",
                "renditionValue": "_360p",
                "url": "https://storage-location.com/enc-asset-url-360.mp4"
            },
            {
                "bitrate": 1721,
                "codec": "H264",
                "renditionValue": "_720p",
                "url": "https://storage-location.com/enc-asset-url-720.mp4"
            },
            {
                "bitrate": 2686,
                "codec": "H264",
                "renditionValue": "_1080p",
                "url": "https://storage-location.com/enc-asset-url-1080.mp4"
            }
        ],
        "hls": "https://storage-location.com/enc-asset-url.m3u8",
        "hlsDetail": {
            "url": "https://storage-location.com/enc-asset-url.m3u8"
        },
        "type": "videoAsset"
    }
}

Fields/Description Table:

Thumbnail Image Sizes API

To manage thumbnail image sizes, use the following API request:

bashCopy codecurl --location 'https://tools.viewlift.com/v2.0/content/video' \
--header 'xApiKey: <YOUR_X_API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "images": {
        "_16x9Images": [
            {
                "url": "<PUBLIC_URL_OF_IMAGE_UPLOADED_ON_S3>"
            }
        ]
    }
}'

API for Additional Image Sizes

For additional image sizes, use the API request below:

bashCopy codecurl --location 'https://tools.viewlift.com/v2.0/content/video' \
--header 'xApiKey: <YOUR_X_API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "images": {
        "_16x9Images": [
            {
                "url": "<PUBLIC_URL_OF_IMAGE_UPLOADED_ON_S3>"
            }
        ],
        "_1x1Images": [
            {
                "url": "<PUBLIC_URL_OF_IMAGE_UPLOADED_ON_S3>"
            }
        ],
        "_32x9Images": [
            {
                "url": "<PUBLIC_URL_OF_IMAGE_UPLOADED_ON_S3>"
            }
        ],
        "_9x16Images": [
            {
                "url": "<PUBLIC_URL_OF_IMAGE_UPLOADED_ON_S3>"
            }
        ],
        "_3x4Images": [
            {
                "url": "<PUBLIC_URL_OF_IMAGE_UPLOADED_ON_S3>"
            }
        ]
    }
}'

Uploading Video Content to ViewLift CMS

To upload video content to the ViewLift CMS using the ViewLift API, you can use the following CURL request. This example demonstrates how to upload a video with specific parameters.

CURL Request

bashCopy codecurl --location 'https://tools.viewlift.com/v2.0/content/video' \
--header 'xApiKey: eDDgMPynXA8W2YeB5b0qe9KtnsuKP96W8aBWQCEF' \
--header 'Content-Type: application/json' \
--data '{
  "drm": {
    "provider": "NONE"
  },
  "autoPublish": true,
  "images": {
    "_16x9Images": [
      {
        "url": "s3://abcTV-network-prod/thumbnails/Who_steps_up_besides_Abby.jpg"
      }
    ]
  },
  "s3Url": "s3://abcTV-network-prod/MezzFiles/2024/04/1713718300810_whostepsupbesidesabby.mp4",
  "title": "Who steps up besides Abby - duplicate test",
  "description": "Who steps up besides Abby",
  "gameSportRadarId": ""
}'

Parameters/Description Table