View Source

After the experience has been started with the Watch call, the Update call is used to send any user interaction to the IRIS.TV API.

Necessary Parameters for an Update Call:

platform_id: the reference ID from the publisher’s CMS
platform: the name of the publisher
experience: Value that defines current stream of videos (generated on Watch call)
access_token: created via OAuth 2 standard
user_id: ID associated to the individual user
client_token: string of characters to authorize the client
behavior: field that covers any user behaviors. Note: multiple behaviors can be included in one Update call

List of Standard Behavior Parameters:

behavior[play]:Video Starts Playing (Value 1)
behavior[video_complete]:Video Complete (Value 1)
behavior[pause]:Video Paused (Value 1)
behavior[next]:Video Skipped/Next (Value 1)
behavior[next_auto]:Next Video Played in Autoplay Mode(Value 1)
behavior[thumbs_up]:User clicked liked (Value 1)
behavior[thumbs_down]:User clicked disliked (Value 1)
behavior[percentage_watched]:Percentage Video Watched (Value 0.0 - 1.0)

See watch call parameters:

recs_only: If set to `true`, an Update call containing behavior[play] should be sent on the iniital video
If `false` then the Watch call will also indicate the start of play of the initial video.

Sample API Call:

User BTORW starts second video on site Incandenza

Call

http://api.iris.tv/update?platform_id=343YOW&platform=Incandenza&access_token=996JVD321AZ&user_id=BTORW&client_token=99999&experience=53ebec0d321d0690858dw5r1&behavior[play]=1

Response

{
"success": true,
"behavior": {
"play": 1
},
"experience": "53ebec0d321d0690858dw5r1"
}

Errors

Invalid Access Token

Status Code: 401 Unauthorized
IRIS.TV Response: “The access token is no longer valid”
Problem: Access Token is invalid or has expired
Solution: Create a new access token using your Client Credentials

Refer Here for documentation on OAuth

Invalid Client Token

Status Code: 401 Unauthorized
IRIS.TV Response: “IRIS API: Check your authentication credentials”
Problem: Client Token is Incorrect

No Experience Included

Status Code: 400 Bad Request
IRIS.TV Response: "Message: invalid experience"
Problem: Experience is missing from update call
Solution: Double check the parameters being sent in on the update call. If still invalid, contact IRIS.TV support.