Hello Guys,

In this tutorial we are going to show how our Player API Works. With this API you can integrate any 3rd party app with IPTV Panel Professional Edition and you can make your own apps.

The API Provides the user with information such as the available playlist (channels), user information (expire date, max connections), channel icons (including movies) and the EPG information for both live & vod.

In general it provides everything you need to cover 100% the panel features.

Let's see how it works first and how you can call it.

How to Call API

You can call the API Simply with the following format

http://your-dns:port/panel_api.php?username={username}&password={password}

You need to replace {username} & {password} with the username and the password of a simple user created under "Add New Line" section and listed on "Manage Lines"

Result

API Returns every result in JSON format so you will need to parse the JSON output in your application and in your desired language.

If you parse the JSON you will get a list of arrays which will result in something like the below

Array
(
    [user_info] => Array
        (
            [username] => a
            [password] => b
            [auth] => 1
            [status] => Active
            [exp_date] =>
            [is_trial] => 0
            [active_cons] => 0
            [created_at] => 1441373291
            [max_connections] => 0
            [allowed_output_formats] => Array
                (
                    [0] => m3u8
                    [1] => ts
                )

        )

    [server_info] => Array
        (
            [url] => ip....
            [port] => 8080
        )

    [categories] => Array
        (
            [live] => Array
                (
                    [0] => Array
                        (
                            [category_id] => 1
                            [category_name] => General Streams
                            [parent_id] => 0
                        )

                )

            [movie] => Array
                (
                    [0] => Array
                        (
                            [category_id] => 2
                            [category_name] => General Movies
                            [parent_id] => 0
                        )

                    [1] => Array
                        (
                            [category_id] => 3
                            [category_name] => Sub Category For General Movies
                            [parent_id] => 2
                        )

                )

        )

    [available_channels] => Array
        (
            [16] => Array
                (
                    [num] => 1
                    [name] => test
                    [stream_type] => live
                    [type_name] => Live Streams
                    [stream_id] => 1
                    [stream_icon] =>
                    [epg_channel_id] => test.gr
                    [added] => 0
                    [category_id] => 11
                    [series_no] =>
                    [live] => 1
                    [container_extension] =>
                    [custom_sid] => :0:1:13f:157c:13e:820000:0:0:0:
                    [tv_archive] => 1
                    [tv_archive_duration] => 2
                )

            [4] => Array
                (
                    [num] => 1
                    [name] => Test Movie
                    [stream_type] => movie
                    [type_name] => Movies
                    [stream_id] => 1390
                    [stream_icon] => http://test:5050/images/1431045.jpg
                    [epg_channel_id] =>
                    [added] => 1456333546
                    [category_id] => 2
                    [series_no] =>
                    [live] => 0
                    [container_extension] => mkv
                    [custom_sid] =>
                    [tv_archive] => 0
                    [tv_archive_duration] => 0
                )

        )

)



If the Username/Password combination is invalid you will get



Array
(
    [user_info] => Array
        (
            [auth] => 0
        )
)



Making the authentication

To make the authentication in your application simply check if the user_info element and auth key is 1.

Secondly you need to check if user_info element and status is Active

The status key indicates if the line is Expired/Blocked/Disabled or Enabled. So if the key is Active that means our user can see all the available channels and use the API correctly.

If the status isn't active you should print a message to the user and do not continue with the API.

status key may return the following:

Banned = Admin has disabled the line under Manage Lines
Disabled = Reseller or admin has disabled the line under Manage Lines
Active = Everything is ok and line can is working
Expired = Line has expired.



Grab Channel URLs

API Does not provide ready-to-use URLs, so you will need to build them in your application.

Every Available Stream has 3 important keys to build the URL.

    stream_id (The Stream ID that the channel is assigned in)
    live (Tells if the stream is live channel or no. 1 means live, and 0 means it's vod )
    container_extension (This is only for VOD. It tells in which container our movie is in).

So when you will parse the available_channels element, you can do something like in pseudo code:

if live = 1 then url = http://dns:port/live/{username}/{password}/{stream_id}.ts
if live = 0 then url = http://dns:port/movie/{username}/{password}/{stream_id}.{container_extension}

In exactly the same you can split the streams in categories using the category_name or category_id.

TV Archive

The TV Archive is available only for Live Channels and you can see if it is enabled by checking the element key "tv_archive" key. If it is 1 , it's enabled and 0 means it's disabled.

Below that you can get the tv_archive_duration that shows the days that the admin has set to keep the tv archive for.

Here is the request for TV Archive/Timeshift, that you can also implement it in your own Players ( Android etc )


http://ip:port/streaming/timeshift.php?username=X&password=X&stream=X&start=2016-03-19:16-00&duration=120

After replacing the username, password with a simple user line and the stream with the Stream ID , you will get a TV Archive from 16:00 pm 2016-03-19 and with the duration of 120 Minutes ( 2 Hours )


Getting EPG

To get the EPG Info for any channel or vod you have to call a url in the below format

http://your-dns:port/panel_api.php?username={username}&password={password}&action=get_epg&stream_id={stream_id}

You will need to replace the {stream_id} with the stream_id based on the available_channels element.


Again the result will be in JSON , if you do a json parsing, you will get an array with all the available EPG.



Simple PHP Sample Code

Here is simple PHP Sample code that will make you understand how all the above works in action.

<?php


$host = 'http://dns:port/';
$username = 'a';
$password = 'b';
########################################################
$api_source = json_decode( file_get_contents( $host . "panel_api.php?username=$username&password=$password" ), true );

if ( !is_array( $api_source ) || empty( $api_source['user_info']['auth'] ) )
{
    echo 'API Error';
    exit();
}


$output_format = getOutputFormat();
$server_url = "http://{$api_source['server_info']['url']}:{$api_source['server_info']['port']}/";


foreach ( $api_source['available_channels'] as $stream_id => $stream_info )
{
    $epg_source = json_decode( file_get_contents( $host . "panel_api.php?username=$username&password=$password&action=get_epg&stream_id=" . $stream_id ), true );

    if ( $stream_info['live'] == 1 )
    {
        $url = $server_url . "live/$username/$password/$stream_id." . $output_format;

        echo "Stream Name: {$stream_info['name']} | URL: {$url}\n";

        //do something with $epg_source
    }
    else
    {
        $url = $server_url . "movie/$username/$password/$stream_id." . $stream_info['container_extension'];
        echo "Movie Name: {$stream_info['name']} | URL: {$url}\n";

        //do something with $epg_source
    }
}

function getOutputFormat()
{
    global $api_source;

    if ( !empty( $api_source['user_info']['allowed_output_formats'] ) )
    {
        return ( in_array( 'ts', $api_source['user_info']['allowed_output_formats'] ) ) ? 'ts' : 'm3u8';
    }

    return false;
}

?>