Introduction

Welcome to mpvPlayer API Guide.

This Guide is supposed to clarify the way how you can work with mpvPlayer.com API.

Using the following documentation you can automate the most often actions with mpvPlayer.

Before you start

In the mpvPlayer Account you can create HTML5 players for your website. You can quickly build the desired video player in an online cabinet.

The player is downloaded as a single file mpvPlayer.js - just add it to your website:

<script src="//url.com/mpvPlayer.js" type="text/javascript"></script>

Add a player to your website

The player's script is simple placed in the head tag of the page and integration code for player container

<div id="mpvplayer"></div>

<script>
   var player = new mpvPlayer({id:"mpvplayer", file:"//url.com/v.mp4"});
</script>

The variables and options:

-file --URL to a video file or mpv Content Catalog
-poster --URL of the image on the start screen of the player
-title --title ща the video
-autoplay --auto start video (1 or 0)
-start --start playback from the specified second
-end --end playback on the specified second
-subtitle --URL of the subtitle

Authorization

To start using mpvPlayer API you have to use authorization process, which is available as several options:

• Access_token with using permanent key is available for paid users.
• For users without additional validation – username and password.
• For users with Goggle Captcha validation.

Authorization by permanent token

You can get a permanent token when you click “Create new token” button located on a Acoount Space. Now we’re going to request one of mpvPlayer API methods, for instance

CURL:

Request:

$ curl -X POST\
-H "Content-type: application/json" '{"acess_token":"yourtoken"}'\ 
https://mpvplayer.com/api/v10/test

Response:

{
"status":"success",
"code":200
}		

Authorization by login and password

We request an auth_token from the server.

CURL:

Request:

$ curl -X POST\
-H "Content-type: application/json"\
'{"username":"yourbox@email.com","password":"yourpassword"}'\ 
https://mpvplayer.com/api/v10/login		

You will receive auth_token in server response if your login and password are correct.

Response:

{
"status":"success",
"code":200,
"auth_token":"ldtrf4o3gf59s148723gsxbq50"
}		

PHP:

<?php
include "mpvPlayerAPI.php";
$api = new mpvPlayerAPI("yourbox@email.com", "yourpassword");
$result = $api->login();
var_dump($result);
/*
bool(true)
*/
var_dump($api->getAuthToken());
/*
string(ldtrf4o3gf59s148723gsxbq50)
*/

Authorization by login and password with ReCaptcha

This option is a bit complicated but it is worth using it due to we are concerned about the security of your account

CURL:

Request:

$ curl -X POST\
-H "Content-type: application/json"\
-d '{"username":"yourbox@email.com","password":"yourpassword"}'\ 
https://mpvplayer.com/api/v10/login

Response:

{
"message":"Please verify your request via re captcha challenge",
"status":"error",
"code":406,
"errorCode":33
}

At first, you should get a unique page with Google captcha.

Request:

$ curl -X POST -H "Content-type: application/json"\
https://mpvplayer.com/api/v10/requestReCaptcha

Response:

{
"status":"success",
"code":200,
"challenge":"9c726b3ce8b34",
"captcha_url":"https://mpvplayer.com/api/v10/requestReCaptcha?id=9c726b3ce8b34"
}

Open captcha_url in your browser and proceed verification. After you receive a link to a unique page with Google captcha and re_captcha_challenge you should open this link, pass captcha, and get unique code re_captcha_response.

All received data you should add to your authorization request do not forget to provide correct user login and password for authorization:

Request:

$ curl -X POST\
-H "Content-type: application/json"\
-d '{"username":"yourbox@email.com","password":"yourpassword"\
"re_captcha_challenge":"9c726b3ce8b34",\
"re_captcha_response":"9c726b3ce8b349c726b3ce8b349c726b3ce8b34"}' \ 
https://mpvplayer.com/api/v10/login

Response:

{
"status":"success",
"code":200,
"auth_token":"ldtrf4o3gf59s148723gsxbq50"
}

PHP:

<?php
include "mpvPlayerAPI.php";
$api = new mpvPlayerAPI("yourbox@email.com", "yourpassword");
$result = $api->login();
var_dump($result);
/*
bool(false)
*/
var_dump($api->request('requestReCaptcha'));
/*
array(4) {
["status"]=>
string(7) "success"
["code"]=>
int(200)
["challenge"]=>
string(13) "807a330502f04"
["captcha_url"]=>
string(59) "https://mpvplayer.com/api/v10/reCaptcha.html?id=807a330502f04"
}
*/

<?php
include "mpvPlayerAPI.php";
$api = new mpvPlayerAPI("yourbox@email.com", "yourpassword");
$result = $api->login(null, null, "807a330502f04", "807a330502f04807a330502f04");
var_dump($result);
/*
bool(true)
*/
var_dump($api->getAuthToken());
/*
string(ldtrf4o3gf59s148723gsxbq50)
*/

Check video link

If you know the URL for video file, you can check the video file status.

You need authorization.

Example:

Request:

$ curl -X POST\
-H "Content-type: application/json"\
-d '{"file":"URL"}' \ 
https://mpvplayer.com/api/v10/getVideoStatus

Response:

{
"status":"success",
"code":200,
"files": [
 {
     "id":1,
     "name":"test",
     "is_available":true,
     "is_folder":false,
     "date_created":"2020-01-01 00:00:01",
     "size":1024,
     "md5":"dsdidfkasldjfhhja"
 }
]
}

How to know that the player is ready to work

You can catch the init event that the player sends after initialization.

Alsoyou can use the ready parameter with the function name that the player will call when it is ready.

Example:

var player = new Playerjs({id:"player", ready:"PlayerReady", file:"..."});
function PlayerReady(id){
   alert("ready");
}

Listeners

You can also catch events with listeners.

Example:

document.getElementById("player").addEventListener("play",onPlay);