Support Center

Displaying a collection in your website

Last Updated: May 26, 2012 11:54PM BST

When you have included kenseicollection.js in your page, you have the kensei.createCollection() function available.  


A collection is created by calling kensei.createCollection() with the required configuration data.  


The configuration can be specified using a json object.  


Required Configuration Properties

  • apiKey: Your api key. You can retrieve this from the dashboard.
  • collectionId: The ID of the collection you wish to embed.
  • thumbnailsContainer: This is the ID of the element that will contain the video thumbnails.
  • playerContainer: This is the ID of the element that will contain the video player.


Example showing only required config properties.

kensei.createCollection({
	apiKey: "apikey",
	collectionId: "collectionId",
	thumbnailsContainer: "thumbnailsContainerDivId",
	playerContainer: "playerContainerDivId"
});



Optional Configuration Properties

  • apiVersion: Specify the api version. This can be useful for legacy applications targeting an older version of the api.
  • apiURL: The url of the kensei api you are using (without the version number). Such as http://test.api.kenseimedia.com.


Example showing all configuration properties.

kensei.createCollection({
	apiKey: "apikey",
	apiVersion: 1.0,
	collectionId: "collectionId",
	apiURL: "https://api.kenseimedia.com",
	thumbnailsContainer: "thumbnailsContainerDivId",
	playerContainer: "playerContainerDivId"
});

Contact Us

desk@kenseimedia.com
http://assets1.desk.com/
false
kenseimedia
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete