Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Available contextual data partners will be given an can utilize the Context API route from IRIS.TV to retrieve the source_url for an iris_id. The contextual data provider will be responsible for querying IRIS.TV when they receive an unknown iris_id.

How to

...

Retrieve an

...

iris_

...

id

Contextual data partners have two scenarios when they will want to match a source_url to an iris_id, which include:

  1. Retrieving the source_url for an unknown iris_id: When they receive If a data partner receives an unknown iris_id from a DSP .  In this use case, the data partner they will need to retrieve the source_url for the unknown iris_id.

  2. Retrieving a new iris_id once the current one has expired: When they If a data partner want to actively retrieve a new iris_id to replace an expired iris_id.

...

  • access_token : created using the OAuth standard. IRIS.TV will provide the data partner with a client ID and client secret.

  • iris_id : The iris_id sent to the data partner by the DSP.

Context API Route for Retrieval:

The iris_id should be passed as a query parameter. The access_token is passed in the header. Here’s a curl example of the request:

Code Block
$ curl -D - -H "Authorization: Bearer eyJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwiYWxnIjoiZGlyIn0..QDidXo9Z96KCluZ4kLbtMg.Fw3Wm064Co78iCFWtBL8Hwp-RX7YgtsvsXGizHKv3w0.EJiELVDD14HmqkuvzPfunjIaKS3427GOaFqsvIs8MUc" https://context.iris.tv/refresh?id=iris_55824d003e738991

If the iris_id is valid, IRIS.TV will return a 200 response with the following parameters:

  • iris_id - the asset’s current iris_id.

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

  • iris_id_next - the iris_id that will be valid after the current one expires.

  • iris_id_next_expires_at - the UNIX timestamp for when the next iris_id will expire.

  • source_url - the source_url for the video asset.

...

Note on “source_url”

...

  • .

  1. If a client’s CDN is using signed URLs, IRIS.TV will only send a stemmed version of the URL that will exclude the dynamically generated token. IRIS.TV will communicate to the data partner both (a) what clients will have stemmed URLs and (b) where the stemming will occur.

  2. “source_url” is not guaranteed to be a unique identifier since some publishers will syndicate content to other publishers. Therefore, the data provider must use the iris_id to identify the asset instead of the “source_url”.

Retrieving the source_url

...

For an

...

Unknown iris_id:

When data partners receive an unknown iris_id from a DSP, they will query IRIS.TV with the unknown iris_id. IRIS.TV will respond with the following:

Code Block
{    "source_url" : "https://cbsi-drphil-video-fastly.global.ssl.fastly.net/2020/02/11/1696087107539/18066_5-f1bce056_444291_5192www.sample_pub_url.mp4",
     "iris_id" : "iris_78191lilpoe019",
     "iris_id_expires_at" : 1588291200,
     "iris_id_next" : "iris_1897aflaja",
     "iris_id_next_expires_at" : 1588401200
     }

Retrieving a

...

New iris_id

...

When One Has Expired:

Once the TTL for an asset’s iris_id has passed, the data partner will query IRIS.TV with an asset URL to retrieve the new iris_id.

...

Code Block
{    "source_url" : "https://cbsi-drphil-video-fastly.global.ssl.fastly.net/2020/02/11/1696087107539/18066_5-f1bce056_444291_5192www.sample_pub_url.mp4",    
     "iris_id" : "iris_78191lilpoe019",
     "iris_expires" : 2020-04-15 17:55:07.582Z,
    "iris_id_next" : "iris_1897aflaja",
     "iris_id_next_expires_at" : 1588401200
     }

Data partners are responsible for the above workflows and how that operates with their DSP partners in order to have valid iris_ids at all times.