INTRODUCTION

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

Notice that getAssets version 05 supports series, podcasts and subgroups, while getAssets versions 03 and earlier do not.

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	number of items needed
series	boolean	Optional	TRUE: will only fetch the latest asset in series. FALSE: will fetch all assets.
podcasts	boolean	Optional	TRUE: asset data has podcast group details. FALSE: Will only have basic info
recursive	boolean	Optional	TRUE: will fetch assets from subgroups too

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

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

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

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

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

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

There are two colons in a row after organizationId. This is intentional.
Do not include groupItemIds, unlike in some other APIs.

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

There are two colons in a row after organizationId. This is intentional.
Do not include groupItemIds, unlike in some other APIs.

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.

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

There are two colons in a row after organizationId. This is intentional.
Do not include groupItemIds, unlike in some other APIs.

1. Key: Authorization
   
2. Value: Bearer + userToken received from login API
   

GET ASSETS

REQUEST

REQUEST

RESPONSE

SUCCESS

VIDEO TOKEN FORMAT

INTRODUCTION

TOKEN FORMAT

1. Version [8 bits/2 chars] – always 1 (“01”)
   
2. IP-address [32 bits/8 chars] – the IP-address that the client has (network byte-order)
   
3. Expire date [32 bits/8 chars] – timestamp when the token should expire in number of seconds since 1970 UTC (network byte-order)
   
4. Signature [128 bits/32 chars] - MD5 sum av {IP-address + ”:” + Expire date + ”:” + Key + ”:” + Path}, where  ’+’ is a string concatenation
   

1. Key – A secret key that is only present on the server creating the token and the server verifying the token.
   
2. Path – The path of the file/directory/stream to protect.