Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 15 Next »

Overview: Below is information pertaining to how IRIS.TV’s Contextual Video Marketplace integrates with Overview: This details how to access contextual segments via an API. This can be used for web and non-web environments, including apps for Android, Roku, Amazon Fire, and other connected devices.

Prerequisites

Before implementing the Context API, the following needs to be completed:

  • A feed with video URLs needs to be provided for IRIS.TV to import and add contextual data to assets. Video asset URLs need to link to either MP4 or m3u8 files.

  • An ad tag that can be appended with iris_context custom key-value pair.

  • Ad targeting on the iris_context key-value pair needs to be set up through the ad server.

Please speak to your IRIS.TV representative for details on these requirements.

This workflow requires three values:

  • client_token: Authentication string associated with each client. This will be provided by IRIS.TV once the content feed is imported.

  • platform_id: The reference ID for the video from the publisher’s CMS.

  • access_token: Token used to authenticate with the IRIS.TV API

Building the Integration

The order of operations for retrieving the context or category information should be as follows:

  1. Call IRIS.TV Context API call to retrieve context and category information on the next asset in the queue.

  2. Add the context segment to the pre-roll ad tag for that video.

This process should be repeated as you iterate through the video playlist.

Formatting the API Call

The API call requires the client token, platform id, and access token. The client and access tokens will be provided after the initial ingest.

A sample of the API call:

https://context.iris.tv/video_info?access_token=90814301lkjafalkj&client_token=PAJEU091&platform_id=6026444633001

The API will respond with a video_info field that includes:

  • iris_id : the asset’s current iris_id.

  • iris_id_expires_at : the UNIX timestamp when the current iris_id will expire.

  • context : contextual segments for the asset

A sample of the API response:

{
  "success": true,
  "video_info": {
    "iris_id": "iris_098eiman91",
    "context": [
      "context_1", 
      "context_2", 
      "context_3"
    ],
    "iris_id_expires_at": 1588636800
  }
}

Note: The Context field will be used for all IRIS.TV Contextual Video Marketplace workflows.

  • No labels

IRIS.TV