All Collections
Developer
Media API documentation
Media API documentation

Version 1.1, 06/02/2019

Aaron Coates avatar
Written by Aaron Coates
Updated over a week ago

Previously known as Video Bricks (videobricks.io) the Money Alive Media API is our method of integration with our Enterprise partners. The content is accessible via a series of RESTful API’s and player templates. To ensure you benefit fully from this service, always request content via these API’s to ensure you are using the latest version of the Money Alive media.

_________

Embed

//#iframe
<frame class="videoPlayer" width="560" height="315" src="https://api.moneyalive.io/{client}/embed/v1/player/{videoid}? token={token}&userid={userid}" frameborder="0" allowfullscreen>

{client}

  • Required 

  • Client title

{videoid}

  • Required 

  • Unique video ID

{token}

  • Required 

MD5 Hash of {apiKey} + {videoID} + {userID} with no spaces

{userid}

  • Required

A unique identifier for the user watching the video Used to identify viewing records

To comply with GDPR, this value should not be in a format that can be used to identify an individual

_________

Embed URL

https://api.moneyalive.io/embed/v1/player/{videoid}?token=
{token}&userid={userid}


{client}

  • Required 

  • Client title

{videoid}

  • Required 

  • Unique video ID

{token}

  • RequiredMD5 Hash of {apiKey} + {videoID} + {userID} with no spaces

{userid}

  • Required

  • A unique identifier for the user watching the video Used to identify viewing records

  • To comply with GDPR, this value should not be in a format that can be used to identify an individual

_________

Analytics Callback

This is a webhook triggered when 95% of the video has been watched in a single viewing:

  • Makes a POST request with a JSON Payload

  • The JSON payload contains the token in the embed URL

{
"videoid": 1,
"userid": 5,
"token": "8b541be6e557259494150e2d192c9d65", "event": "videoCompleted",
"timestamp": "2017-08-21T11:37:43.505Z"
}

_________


GET multiple videos

https://api.moneyalive.io/{client}/v1/videos?page=1&perPage=5&key=
{apiKey}


Page ('page')

  • Optional

  • Which page of the list of videos to request

Per Page ('perPage') 

  • Optional

  • How many videos by which to limit each page

Example JSON Payload

{
"page": 1,
"total": 23,
"perPage": 5,
"next": "https://api.moneyalive.io/{client}/v1/videos?
page=2&perPage=5&key={apiKey}", "previous": "",
"items": [
{
"id": 8,
"createdAt": "2017-08-20T17:20:00.536Z",
"title": "Guide to guaranteed income ", "description": "A guide to using your pension pot to
provide a guaranteed retirement income for life by purchasing an annuity. ",
"thumbnail": "//images.contentful.com/yl1klyj7ws36/6g2uAd8VjiM0a6EMa4cSSW/0a931dc33d1 1.jpg",
"transcript": ""
},
...
]
}

_________

GET a single video

https://api.moneyalive.io/{client}/v1/videos/{videoid}?key={apiKey}

Example

{
"id": 8,
"createdAt": "2017-08-20T17:20:00.536Z",
"title": "Guide to guaranteed income ",
"description": "A guide to using your pension pot to provide a
guaranteed retirement income for life by purchasing an annuity.", "thumbnail":
"//images.contentful.com/yl1klyj7ws36/6g2uAd8VjiM0a6EMa4cSSW/0a931dc33d1 1.jpg",
"transcript": ""
}


_________


GET thumbnail

https://{client}.videobricks.io/resource/v1/thumbnail/{videoId}
  • Get thumbnail of video with given video ID. 

  • No api key is required.

  • The response is the raw thumbnail data, served just like a static file.

_________


Get all topics

https://api.moneyalive.io/{client}/v1/topics?page=1&perPage=5&key=
{apiKey}
  • Get all topics for the client 

  • Topics are sorted by their id

{
"page": 1,
"total": 14,
"perPage": 5,
"next": "https://api.moneyalive.io/{client}/v1/topics?page=2&perPage=5&key={apiKey}",
"previous": "",
"items": [{
},
...
]
}

_________


GET one topic

https://api.moneyalive.io/{client}/v1/topics/{topicid}&key={apiKey}
  • Get one topic for the client

  • Replace {topicid} with the id of a topic e.g. "pension-freedoms"

Example JSON Payload

{
"id": "pension-freedoms", "title": "Pensions Freedoms", "description": ""
}

_________



If you have any questions about the Media API please email [email protected]

Did this answer your question?