Javascript SDK

❗️

This SDK is working around api.dailymotion.com endpoints and should only be used for specific use cases.

We invite you to use partner.api.dailymotion.com endpoints if you are using client credentials authentification.

The JavaScript SDK is available on GitHub and must be loaded from https://api.dmcdn.net/all.js. This SDK will provide access to the features of the Platform API.

Overview

Loading the SDK

You can load the SDK using a <script> element and by calling the DM.init() method. Below is an example of initializing the SDK with all the common options turned on:

<script src="https://api.dmcdn.net/all.js"></script>
<script>
  DM.init({
    apiKey: 'YOUR API KEY',
    status: true, // check login status
    cookie: true // enable cookies to allow the server to access the session
  });
</script>

Loading the SDK asynchronously

The most efficient way to load the SDK in your site is to load it asynchronously so it does not block loading other elements of your page. This is particularly important to ensure fast page loads for users and SEO robots/spiders. Below outlines an example:

<script>
  window.dmAsyncInit = function()
  {
    DM.init({ apiKey: 'your app id', status: true, cookie: true });
  };
  (function() {
    var e = document.createElement('script');
    e.async = true;
    e.src = 'https://api.dmcdn.net/all.js';

    var s = document.getElementsByTagName('script')[0];
    s.parentNode.insertBefore(e, s);
  }());
</script>

In the example above, the function assigned to window.dmAsyncInit is run as soon as the Dailymotion JavaScript SDK is loaded. Any code you want to run after the SDK is loaded should be placed within this function and after the call to DM.init(). For example, this is where you would test the logged in status of the user or subscribe to any Dailymotion events your application is interested in.

Authentication

The Dailymotion JavaScript SDK allows you to log your users with their Dailymotion account in order to act on their behalf: access content, publish or edit videos, etc. For this purpose, you can use any of:

Methods

In addition, you can subscribe to the following events using DM.Event.subscribe():

• auth.statusChange
• auth.sessionChange
• auth.login
• auth.logout

Make an API call

You can make Graph API requests using DM.api() method:

var handleAPIResponse = function (response) {
  alert('Name is ' + response.screenname);
};

DM.api('/user/rs', {
  fields: 'screenname'
}, handleAPIResponse);

SDK Reference

DM.api()

The JavaScript SDK allows you to build rich applications that can make API calls against the Dailymotion servers directly from the user's browser. This can improve performance in many scenarios, as compared to making all calls from your server. It can also help reduce, or eliminate the need to proxy the requests through your own servers, freeing them to do other things.

Signature

DM.api(path, method, params, callback)

Parameters

Except path, all arguments to this method are optional.

Examples

If you have an authenticated user, get their User Object:

var handleAPIResponse = function (response) {
  alert('Your name is ' + user.screenname);
};

DM.api('/me', {
  fields: 'screenname'
}, handleAPIResponse);

Get the 3 most recent posted video from the authenticated user:

var handleAPIResponse = function(response) {
  alert('Got ' + response.list.length + ' videos' + (response.has_more ? ' and has more' : ''));
};

DM.api('/me/videos', {
  limit: 3
}, handleAPIResponse);

Search for videos with "javascript tutorial" query:

var handleAPIResponse = function(response) {
  alert(response.list[0].title);
};

DM.api('/videos', {
  search: 'javascript tutorial',
  fields: 'title'
}, handleAPIResponse);

If you have an authenticated user with write permission scope and you want to like a video for them:

var videoId = 'xk2jd2';

var handleAPIResponse = function(response) {
  if (!response || response.error)
  {
    alert('Error occured');
  }
  else
  {
    alert('Liked successfuly');
  }
};

DM.api('/me/favorites/' + videoId, 'post', handleAPIResponse);

DM.getLoginStatus()

Find out the current status from the server, and get a session if the user is connected.

The user's status or the question of who is the current user is the first thing you will typically start with. For the answer, we ask dailymotion.com. Dailymotion will answer this question in one of two ways:

• Someone you don't know.
• Someone you know and have interacted with. Here's a session for them.

Here is how you find out:

DM.getLoginStatus(function(response)
{
  if (response.session)
  {
    // logged in and connected user, someone you know
  }
  else
  {
    // no user session available, someone you dont know
  }
});

The example above will result in the callback being invoked once on load based on the session from www.dailymotion.com. JavaScript applications are typically written with heavy use of events, and the SDK encourages this by exposing various events. These are fired by the various interactions with authentication flows, such as DM.login().

Events

The DM.Event.subscribe and DM.Event.unsubscribe functions are used to subscribe to these events. For example:

DM.Event.subscribe('auth.login', function(response)
{
  // do something with response
});

The response object returned to all these events is the same as the response from DM.getLoginStatus DM.login or DM.logout. This response object contains:

Parameters

DM.getSession()

Synchronous accessor for the current Session. The synchronous nature of this method is what sets it apart from the other login methods. It is similar in nature to DM.getLoginStatus(), but it just returns the session. Many parts of your application already assume the user is connected with your application. In such cases, you may want to avoid the overhead of making asynchronous calls.

Note: Yo

Overview

Loading the SDK