This API is used to query for media assets that are published. The API includes various calls for getting data for published assets in your account.

API PATH

/api/publishing/

API: VERSION 05

GET ASSETS

REQUEST

/api/publishing/getAssets?version=05

Parameters:

Name	Value	Requirement	Info
organizationId	number	Mandatory
token	string	Mandatory
groupItemId	number(or comma separated multiple)	Mandatory	Id for the group item for which assets are needed. Can be single ID or comma separated list of IDs
userId	number	Optional	If this parameter is not supplied then only public assets will be returned
languageId	string	Optional
userAgent	string	Optional	If given, will take precedence over the auto-detected device type
keyword	string	Optional	will search keyword in name and description
orderBy	string	Optional	Valid values: "publishStart", "title"
order	string	Optional (Mandatory if orderBy given)	"asc", "desc"
limit	number	Optional Optional	number of items needed
series	boolean	Optional (Default true)	TRUE: will only fetch the latest asset in series. FALSE: will fetch all assets.
podcasts	boolean	Optional (Default false)	TRUE: asset data has podcast group details. FALSE: Will only have basic info
recursive	boolean	Optional (Default false)	TRUE: will fetch assets from subgroups too

A token consists of 42 character long hex value. The value has two different parts:

• Version [8 bits / 2 chars] - current version
• Current time [32 bits / 8 chars] - current timestamp in number of seconds since 1970 UTC
• Signature [128 bits / 32 chars] - the MD5 hash of (organizationId + ":" + groupItemId + ":" + Current time + ”:” + Key), where ’+’ is a string concatenation

Key - A secret key that is only present on the client creating the token and the server verifying the token and is defined for the organization.

Example:
Version = ”05”
organizationId = ”14806”
groupItemId = ”12345”

Current time = 1222516160 (Sat Sep 27 13:49:20 CEST 2008) -> ”48de1dc0”
Key = ”secret”
Signature = MD5("14806:12345:48de1dc0:secret") -> ”cb8fd8167db7e97707301d5a2d03886c”

Then token would be "0548de1dc0cb8fd8167db7e97707301d5a2d03886c".

https://suite.icareus.com/api/publishing/getAssets?version=03&organizationId=14806&groupItemId=12345&token=0548de1dc0cb8fd8167db7e97707301d5a2d03886c

RESPONSE

RESPONSE INFO

The response of getAssets is based on how the content in configured in Assets Management. Public assets are returned for all users & guests. Private assets are only returned for valid users (so userId has to be supplied in order to retrieve private assets)

SUCCESS

{   "assets":[     {       "coverImageSmall":"",       "series":[         {           "id":1516002,           "name_stripped":"Kulttuuri ja vapaa-aika",           "name":"Kulttuuri ja vapaa-aika"         }       ],       "ingress":"ingress",       "embedUrl":"https://suiterc.icareus.com/web/helsinkikanava1/player/embed/vod?assetId=1516501%22,       "publishEnd":2524608000000,       "folders":[         {           "id":1406601,           "name_stripped":"Kulttuuri",           "name":"Kulttuuri"         },{           "id":1406605,           "name_stripped":"Kaupunginvaltuusto",           "name":"Kaupunginvaltuusto"         }       ],       "date":1594271160000,       "contentTypes":[],       "episodeNumber":0,       "publisher":"Publish company",       "releaseYear":1997,       "id":1516501,       "thumbnailSmall":"https://suiterc.icareus.com/image/image_gallery?img_id=1517207%22,       "thumbnailMedium":"https://suiterc.icareus.com/image/image_gallery?img_id=1517208%22,       "description":"<p>Suspendisse ullamcorper, leo in placerat eleifend. felis tortor. Donec sodales viverra diam vitae dictum.<\/p>",       "name":"A video with a title",       "actors":"Mike Miller, Jack Pickelson",       "accessInfo":{"products":[]},       "bannerImageSmall":"",       "groups":"Kulttuuri | Kaupunginvaltuusto | Koulutus","programName":"",       "isPodcast":false,       "tags":"",       "coverImageLarge":"",       "productionCompany":"",       "contentRatings":[],       "isSerie":false,       "bannerImageLarge":"",       "isPodcastAsset":false,       "seasonNumber":0,       "coverImageMedium":"",       "director":"Director Joe",       "podcasts":[],       "duration":60,       "views":0,       "quality":1,       "thumbnailLarge":"https://suiterc.icareus.com/image/image_gallery?img_id=1517209%22,       "bannerImageMedium":"",       "rating":0,       "groupItemIds":"1406601,1406605,1556001",       "avMood":"",       "podcast": {         "coverImageSmall":"",         "coverImageLarge":"",         "coverImageMedium": "",         "coverImageUrl": "",         "bannerImageSmall": "",         "bannerImageMedium": "",         "bannerImageLarge": "",         "bannerImageUrl": "",         "thumbnailSmall": "",         "thumbnailMedium": "",         "thumbnailLarge": "",         "thumbnailImageUrl": "",         "iconImageUrl": "",         "id": 500500,         "title": "Podcast group title",         "description": "Long description"       }     }   ],   "status":"ok" }

Response fields:

Field name	Description
METADATA
id	asset's unique id
embedUrl	URI if you want to embed asset to your page
IMAGE FIELDS
bannerImageSmall, bannerImageMedium, bannerImageLarge	URI for banner image
coverImageSmall, coverImageMedium, coverImageLarge	URI for cover image
thumbnailSmall, thumbnailMedium, thumbnailLarge	URI for thumbnail image
ASSET INFO	Mostly selfexplanatory
name, description, ingress
actors, director, publisher, productionCompany
releaseYear	Releast year (full year)
duration	Duration in seconds
PUBLISH TIMES	These are times when asset in available in the service
date	Publish start time
PublishEnd	Publish end time
CATEGORY / GROUP INFO
folders	List of asset's group (id, name and name_stripped)
groups	List of group's titles separated with |
groupItemsIds	List of group's id's separated with ,
SERIES INFO
isSerie	Boolean value: Does asset belong to any serie
series	Series info (id, name, name_stripped)
PODCAST INFO
isPodcastAsset	Boolean value: Is asset a podcast
podcasts	Podcast group indo (id, name, name_stripped)
podcast	Only returned if podcasts=true. Returns all information of podcast group (image etc)

ERROR