The following documentation explains how data partners can send an IRIS_ID to the IRIS.TV Video Data Platform and receive data for that video.
Overview
The following documentation explains how IRIS-enabled data partners to send an IRIS_ID to the IRIS.TV Video Data Platform and receive data for the IRIS_ID that IRIS.TV has contracted the partner to have access to.
IRIS_ID Data API Route
To retrieve video data for an IRIS_ID partners will utilize the following API route:
<https://api.iris.tv/v2/context/data_partner/metadata/video_assets>
Required Parameters to Authenticate the API:
-
The IRIS.TV team will provide the above API credentials to each DSP partner.
-
access_token: Token used to authorize with the IRIS.TV API.
-
client_token: Token used to grant access to specific data for each IRIS_ID.
-
iris_id : Unique identifier for a video asset in the IRIS.TV platform.
-
Example API Call:
https://api.iris.tv/v2/context/data_partner/metadata/video_assets?access_token=f03645dbbe78c5a290db5d5218d4ef6de618ef037b097c138a4a8fc8a2e4338r&client_token=Z5H3CEGS0YXVEU5&iris_id=iris_0014bf6380890di3
API Response
When partner makes a request to the API with an IRIS_ID the IRIS.TV API will respond with the data for each IRIS_ID.
Example API Response:
{
"closed_caption_url": null,
"source_url": "NOT_AVAILABLE",
"title": null, "thumbnail_url": null,
"description": null,
"billing_id": 22736, "iris_id": "iris_852a26f0b747431b",
"source_keywords": null, "length_secs": null
}
API Responses
200: Valid call
204 : Unknown IRIS_ID
401 : Unauthorized client_token or access_token