The following explains how publishers can integrate the Context API.
The Context API can be used for retrieving contextual data across from IRIS.TV, across all devices and formats. The Context API can also be installed in either client or server-side making it CSAI or SSAI compatible.
Installing Context API Call
Calling the API
The Context API call requires the following parameters:
- access_token: token assigned to the publishers parent account (parent media company)
- client_token: token assigned to the publishers child account (site, app or channel)
-
platform_id: the reference ID (GUID) for the individual asset in your CMS you wish to receive contextual or brand-safety data for
*The client and access tokens will be provided to you by IRIS.TV after the content feed has been set up in the IRIS.TV platform and the initial ingest of assets has been completed.
See a sample of the Context API call here:
https://context.iris.tv/video_info?access_token=90814301lkjafalkj&client_token=PAJEU091&platform_id=6026444633001
The Context API Response
The API will respond with a video_info field that includes the following:
-
iris_id: the asset's persistent video ID assigned by IRIS.TV
-
context: the contextual data for the asset created by IRIS.TV's context ands brand-safety data partners
See a sample of the Context API response here:
{
"success": true,
"video_info": {
"iris_id": "iris_098eiman91fue7",
"context": [
"ic_1234567",
"ic_2345678",
"ic_3456789"
]
}
}
After the Integration is Complete
Once the integration is complete and you’re receiving contextual segments, move on to Activating Contextual Data to the Ad Server in order to add the data into your existing ad workflow.