Просмотр исходного текста страницы API


== Термины ==

Контент – видео/аудио или текстовая информация.

Сервис – программно-аппаратный комплекс предоставления доступа к IPTV как к услуге.

Клиент – приложение или устройство, получающее доступ к Сервису посредством учет-
ной записи.

Абонент – физический пользователь сервиса SUNDUK.TV

Абонемент – учетная запись клиента. Логин и пароль цифровые – для удобства набора со
стандартного пульта управления устройства (settopbox).

Сервер вещания  – программно-аппаратный комплекс для организации
трансляции потокового видео и радиосигнала.

Ссылка вещания – URL, по адресу которого сервер вещания транслирует контент.

Middleware – комплекс технологического программного обеспечения для авторизации и обеспечения взаимодействия между различными приложениями, системами, компонентами.

API – интерфейс Middleware для программного взаимодействия с клиентом.

== Описание принципов работы с API ==

Провайдер транслирует видеопотоки телевизионных и радио каналов в сети Интернет через сеть своих серверов по протоколу HLS. Видео в формате H.264 и звук AAC/AC3
URL являются динамическими привязанными к конкретной сессии, с ограниченным сроком жизни (устаревающие).
Для начала работы с сервисом необходима авторизация, при успехе которой, сервер выдаст ключ к сессии, ЭТОТ КЛЮЧ НЕОБХОДИМО УКАЗЫВАТЬ ПРИ КАЖДОМ ОБРАЩЕНИИ К СЕРВЕРУ. Указать ключ можно двумя способами - через cookies или URL
Схема работы приложения:

1. Авторизация на сервере и скачивание настроек клиента /login

2. Получение программы передач (EPG),  список каналов и группы каналов /channel_list

3. Когда абонент выбирает канал, нужно получить  ссылку вещания для этого канала /get_url

4. Проигрывание полученного URL

5. По окончании передачи необходимо загрузить следующий EPG элемент  /epg_current

6. Также можно загрузить EPG за весь день при просмотре программы за данный день, а также при выборе передачи из архива

== Как использовать этот API ==

Вы можете использовать любой язык программирования при работе с данным API. Работа с API осуществляется по протоколу HTTP, 
обмен данными происходит в формате XML или JSON, Вам понадобятся эти библиотеки. 
В формате JSON удобнее работать с HASH массивами и мы рекомендуем этот формат. 
Запросив один раз, старайтесь кешировать у себя данные HASH, URL или EPG, пока они не устареют.
Этим вы ускорите работу клиента, и не создадите лишнюю нагрузку на сервера
 
Все запросы к API происходят по протоколу http, и имеют следующий вид: 

httр://iptv.sunduk.tv/api/<тип ответа>/<имя функции>?param1=value&param2=value...

<тип ответа> задает формат выходных данных. Данные могут быть типов: XML, JSON, JSONP

Примеры вызовов:

httр://iptv.sunduk.tv/api/xml/epg?cid=2&day=260212

httр://iptv.sunduk.tv/api/json/epg?cid=2&day=260212

httр://iptv.sunduk.tv/api/jsonp/epg?cid=2&day=260612&callback=process

Все возвращаемые сообщения имеют вид ассоциативного массива.

В случае ошибочного запроса API возвращает XML-пакет следующего содержания:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
  <error>
    <message>ERROR_MESSAGE</message>
    <code>ERROR_CODE</code>
  </error>
  <servertime>SERVER_TIME</servertime>
</response></pre>

''message'' - сообщение об ошибке

''code'' - код ошибки

''servertime'' - время на сервере (формат unixtime)

== Формат времени ==

Все данные, обозначающие дату и время, представлены в формате unixtime. Каждый ответ серве- ра имеет отпечаток времени сервера (для синхронизации) с тегом <servertime>

== Cookie ==

Для идентификации и создания сессии используется стандартный механизм HTTP/COOKIE.
При первом входе необходимо выполнение login. При корректном входе возвращается парамет- ры состояния, данные по клиенту и COOKIE, которые необходимо передавать при последующих запросах. В COOKIE хранится идентификатор сессии. Если запрос не содержит COOKIE, то это вызо- вет ошибку. Для корректного завершения сессии необходимо вызвать метод logout. COOKIE уста- навливается стандартным HTTP ответом, поэтому если клиент использует браузер или фреймворк, то COOKIE будут передаваться автоматически, в противном случае клиент должен позаботиться об сохранении ключа сессии.
Также возможна передача параметров &<имя сессии>=<ключ сессии> через url. <Имя сессии> при этом необходимо брать из ответа пакета функции /login. Подобный метод из соображений без- опасности является не желательным, ровно как и передача login методом GET. Рекомендуем ис- пользовать HTTPS (безопасное шифрованное соединение через SSL) для авторизации.

== Функции API ==

=== login ===

Функция выполняет авторизацию клиента.

Вызов: 

'''/login?login=<login>&pass=<password>[&device=<device_name>[&device_id=<device_id>]]'''

Входные параметры:

'''''login'''''       - номер абонемента, выданный абоненту

'''''pass'''''        - пароль абонемента

'''''device'''''      - Задает группу устройств при работе с настройками. Принимает значение, заданное для данного устройства по договоренности (например: mag, dunehd, lg_smart_tv) 

'''''device_id'''''   - Задает конкретное устройство из указанной группы при работе с настройками. Принимает значение, уникальное для устройства из данной группы (например: мак-адрес, серийный номер, ключ HDCP)

Пример ответа по запросу /login?login=1234567&pass=1234567&device=dunehd&device_id=f21g3b17a3:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
    <sid>1875BCF912FE8ABF89ABF2E4FE</sid>
    <sid_name>TVAPI_SID</sid_name>
    <account>
        <login>000000</login>
        <packet_name>Sunduk.tv</packet_name>
        <packet_expire>1514584800</packet_expire>
    </account>
    <services>
        <vod>1</vod>
        <archive>1</archive>
    </services>
    <settings>
        <http_caching>
            <name>http_caching</name>
            <value>4000</value>
            <list>
                <item>1500</item>
                <item>3000</item>
                <item>5000</item>
                <item>8000</item>
                <item>150000</item>
            </list>
        </http_caching>
        <stream_server>
            <name>stream_server</name>
            <value>usatv1.sunduk.tv</value>
            <list>
                <item>
                    <ip>tv1.sunduk.tv</ip>
                    <descr>Europe 1</descr>
                </item>
                <item>
                    <ip>usatv1.sunduk.tv</ip>
                    <descr>USA 1</descr>
                </item>
            </list>
        </stream_server>
        <timeshift>
            <name>timeshift</name>
            <value>0</value>
            <list>
                <item>0</item>
                <item>1</item>
                <item>2</item>
                <item>3</item>
                <item>4</item>
                <item>5</item>
                <item>6</item>
                <item>7</item>
                <item>8</item>
                <item>9</item>
                <item>10</item>
                <item>11</item>
                <item>12</item>
            </list>
        </timeshift>
        <timezone>
            <name>timezone</name>
            <value>+2</value>
        </timezone>
        <bitrate>
            <name>bitrate</name>
            <value>Economy</value>
            <list>
                <item>Automatic</item>
                <item>Standart</item>
                <item>Economy</item>
            </list>
        </bitrate>
        <bitratehd>
            <name>bitratehd</name>
            <value>Automatic</value>
            <list>
                <item>Automatic</item>
                <item>Standart</item>
                <item>Economy</item>
            </list>
        </bitratehd>
        <archivebitratesd>
            <name>archivebitratesd</name>
            <value>Standart</value>
            <list>
                <item>Standart</item>
                <item>Economy</item>
            </list>
        </archivebitratesd>
        <archivebitratehd>
            <name>archivebitratehd</name>
            <value>Standart</value>
            <list>
                <item>Standart</item>
                <item>Economy</item>
            </list>
        </archivebitratehd>
    </settings>
    <servertime>1423845147</servertime>
</response></pre>

Описание параметров из ответа:

''sid'' - Идентификатор сессии

''sid_name'' - Имя переменной идентификатора сессии

''account'' -  Блок данных абонемента

''login'' - Логин

''packet_name'' -  Название пакета

''packet_expire'' - Дата и время окончания абонемента

''services'' - Блок флагов сервисов

''vod'' - Флаг видеотеки. При установленном значении 1 абонементу доступна услуга «видеотека»

''archive'' - Флаг архива. При установленном значении 1 абонементу доступна услуга «архив»

=== logout ===

Описание функции: выполняет отключение клиента от сервиса. 

Вызов без параметров

'''/logout'''

Возвращает ответ вида:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
  <message>M_LOGOUT_OK</message>
  <servertime>1407232800</servertime>
</response></pre>

Описание параметров из ответа:

''message'' - Сообщение об логауте

''servertime'' - Время на сервере (в формате unixtime)

=== channel_list ===

Получение списка каналов.

Вызов:

'''/channel_list[?show=<base|all>[&protect_code=<пароль закрытых каналов>]]''' 

В этом случае будет показан список всех каналов с дополнительным тегом <hide>0</hide>, который указывает скрыт ли канал в обычном режиме.
В списке для каждого канала также имеется «таблица» возможных сочетаний bitrate и timeshift. Может сложиться ситуация, когда установленный системный bitrate в сочетании с timeshift не задан для некоторых каналов. В этом случае каналы не попадают в список /channel_list. Информация доступна в теге <stream_params>

Входные параметры:

'''''show''''' - (По умолчанию: base) Режим отображения списка каналов. all = показ всех каналов в т.ч. скрытых.

'''''protect_code''''' - Цифровой пароль для закрытых каналов. Обязательный параметр при show=all

Функция возвращает ответ вида:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
  <groups>
    <item>
      <id>GROUP_ID</id>
      <name>GROUP_NAME</name>
      <color>CSS_CODE</color>
      <channels>
        <item>
          <id>CHANNEL ID</id>
          <name>CHANNEL_NAME</name>
          <stream_params>
            <item>
              <rate>BITRATE</rate>
              <ts> TIMESHIFT</ts>
            </item>
          </stream_params>
          <is_video>IS_VIDEO</is_video>
          <protected>PROTECTED</protected>
          <have_archive>HAVE_ARCHIVE</have_archive>
          <icon>ICON_PATH</icon>
          <epg_progname>EPG_PROGNAME</epg_progname>
          <epg_start>EPG_START</epg_start>
          <epg_end>EPG_STOP</epg_end>
          <ac3_audio>Bollean</ac3_audio>
</item>
        ...
      </channels>
    </item>
  </groups>
  <servertime>1407232800</servertime>
</response></pre>

Описание параметров из ответа:

''groups/item/id'' - идентификатор группы

''groups/item/name'' - название группы

''groups/item/color'' -  CSS код цвета группы

''groups/item/channels/item/id'' - идентификатор канала

''groups/item/channels/item/name'' -  название канала

''groups/item/channels/item/stream_params'' - возможные параметры потоков

''groups/item/channels/item/stream_params/item/rate'' - возможный битрейт канала. Устанавливается в настройках переменной bitrate

''groups/item/channels/item/stream_params/ item/ts'' - таймшифт в часах. Например: значение 2 - задержка вещания на 2 часа. Получить url вещания возможно установив в настройках переменную timeshift

''groups/item/channels/item/is_video'' -  флаг потокового видео 0/1 1-видео, 0-радио

''groups/item/channels/item/need_bandwidth'' - рекомендуемый битрейт канала

''groups/item/channels/item/protected'' -  флаг “защиты канала по паролю” 0/1

''groups/item/channels/item/have_archive'' - флаг “имеет ли канал архив” 0/1

''groups/item/channels/item/icon'' -  относительный путь к файлу иконки канала

''groups/item/channels/item/epg_progname'' - название текущей телепередачи

''groups/item/channels/item/epg_start'' -  дата и время начала текущей передачи

''groups/item/channels/item/epg_stop'' - дата и время окончания текущей передачи

''groups/item/channels/item/ac3_audio'' - Если канал транслируется с 5.1 звуком  AC3 параметр true

Пример ответа по запросу /api/xml/channel_list

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
    <groups>
        <item>
            <id>7</id>
            <name>Общие</name>
            <color>#ff2200</color>
            <channels>
                <item>
                    <id>71</id>
                    <name>Первый</name>
                    <stream_params>
                        <item>
                            <rate>Automatic</rate>
                            <ts>0</ts>
                        </item>
                        <item>
                            <rate>Standart</rate>
                            <ts>0</ts>
                        </item>
                        <item>
                            <rate>Economy</rate>
                            <ts>0</ts>
                        </item>
                    </stream_params>
                    <is_video>1</is_video>
                    <need_bandwidth>2500</need_bandwidth>
                    <protected>0</protected>
                    <have_archive>1</have_archive>
                    <icon>/uploads/vddd2zziip.jpg</icon>
                    <epg_progname>"Человек и закон" с Алексеем Пимановым (12+)</epg_progname>
                    <epg_start>1423842300</epg_start>
                    <epg_end>1423846200</epg_end>
                    <hide>0</hide>
                    <ac3_audio>0</ac3_audio>
                </item>
                <item>
                    <id>112</id>
                    <name>Первый HD</name>
                    <stream_params>
                        <item>
                            <rate>Automatic</rate>
                            <ts>0</ts>
                        </item>
                        <item>
                            <rate>Standart</rate>
                            <ts>0</ts>
                        </item>
                        <item>
                            <rate>Economy</rate>
                            <ts>0</ts>
                        </item>
                    </stream_params>
                    <is_video>1</is_video>
                    <need_bandwidth>2500</need_bandwidth>
                    <protected>0</protected>
                    <have_archive>1</have_archive>
                    <icon>/uploads/ept2dfsoxd.jpg</icon>
                    <epg_progname>"Человек и закон" с Алексеем Пимановым (12+)</epg_progname>
                    <epg_start>1423842300</epg_start>
                    <epg_end>1423846200</epg_end>
                    <hide>0</hide>
                    <ac3_audio>0</ac3_audio>
                </item>
          
            </channels>
        </item>
    </groups>
    <servertime>1423845361</servertime>
</response></pre>

=== channel_last ===

Получение id последнего просматриваемого канала, если последний канал не найдет отдается значение 0.

Вызов: 

'''/channel_last'''

Возвращает ответ вида:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
    <channel>
        <id>71</id>
    </channel>
    <servertime>1425410393</servertime>
</response>

</response></pre>

=== get_url ===

Получение ссылки вещания на заданный канал.

Вызов: 

'''/get_url?cid=<ИД канала>[&gmt=<дата время позиции архива>][&stream_protocol=<hls|hds|mpegts|embeded|rtsp>][&protect_code=<пароль для закрытых каналов>]'''

Входные параметры:

'''''cid''''' - Идентификатор канала, полученный из функции [[#channel_list|channel_list]]

'''''gmt''''' - Используется в качестве начального момента для получения потока из архива. В формате unixtime

'''''stream_protocol''''' - (По умолчанию: hls) В каком протоколе вещания вы хотите получить  ссылку. Возможные протоколы: hls, hds, mpegts, embeded, rtsp

'''''protect_code''''' - Цифровой пароль для закрытых каналов. Если канал закрыт, а пароль не передан, либо передан неверный пароль, то в тэге <url> возвращается слово "protected".

Архив. Сервисом организована запись некоторых телеканалов сроком до 14 дней для дальнейшего вещания по требованию. Каналы имеющие архивную запись помечены флагом have_archive в списке каналов. Доступ к записанным данным возможен через указание параметра gmt для функции get_url, где указано время в формате unixtime. 

Возвращает ответ вида:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
    <url>http://usatv1.sunduk.tv:8080/C515/index.m3u8?token=83f801c99e7e5a79e020742b :http-caching=8000 :no-http-reconnect
    </url>
    <servertime>1423845671</servertime>
</response></pre>

URL специально сгенерирован с соответствующими оптимизированными параметрами. URL генерируется только один раз. Для повторного просмотра канала необходимо получить заново сгенерированный URL.

== Набор функций для работы с EPG ==

Телевизионная программа передач (EPG) требует особого подхода к реализации и понимания происходящих процессов. Генерация EPG на стороне сервера достаточно трудоемкий процесс и сопряжен с опасностью перегрузки системы при неправильной реализации. Каждый разработчик желает чтобы его приложение максимально быстро отвечало требованиям пользователя, но эти требования не всегда оправданы. Мы рекомендуем разработчикам использовать механизм ке- ширования данных EPG на сколько это возможно. Время жизни cache в этом случае целесообразно будет устанавливать в 3 часа. Это оптимальное значение. Особого смысла загружать ВЕСЬ EPG нет, поскольку данные не всегда будут востребованы. Идеальным вариантом был бы механизм фоновой подгрузки EPG основанный на событии окончания телепрограммы. Другими словами, при окончении телепередачи следует загружать данные о следующей телепередачи (или о не- скольких). Для реализации этого меанизма была разработана функция /epg_current.
Просьба обратить внимание на тот факт, что многие пользователи привыкли к так называемому сёрфингу каналов – простое перелистывание с канала на канал не особо вчитываясь в содержимое EPG. Или же путем «пробежки» по каналам выбирать нужный им канал. В этом случае не стоит немедленно подгружать EPG по событию перехода на канал, а выдержать паузу 0.6 секунды (значение было выявлено эмпирически).

=== epg ===
Получение программы передач для заданного канала на период времени с gmt по. 

Вызов:

'''/epg?cid=<идентификатор канала>&day=<дата формата DDMMYY>'''

Входные параметры для функции:

'''''cid''''' - Идентификатор канала, полученный из функции [[#channel_list|channel_list]]

'''''day''''' - Дата формата DDMMYY. День за который будет возвращена телепрограмма

'''''gmt''''' - Время unixtime. Начало периода длительностью в одни сутки, для которого будет возвращена телепрограмма. (В дальнейшем будет использоваться вместо параметра day. На данный момент не реализовано на стороне API, но требуется реализация на стороне клиента) 


Возвращает ответ вида:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
<epg> <item>
      <ut_start>UT_START</ut_start>
      <progname>PROG_NAME</progname>
    </item>
... </epg>
  <servertime>SERVER_TIME</servertime>
</response></pre>

Описание параметров ответа:

''ut_start'' - Дата и время начала передачи в формате unixtime

''progname'' - Название передачи

Пример ответа:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
    <epg>
        <item>
            <ut_start>1420065300</ut_start>
            <progname>В дебрях Африки (Сахара) (12+)</progname>
            <pdescr/>
        </item>
        <item>
            <ut_start>1420068300</ut_start>
            <progname>Живая природа (Слониха по имени Эхо - заключительная глава) (12+)</progname>
            <pdescr/>
        </item>
 </epg>
    <servertime>1423846518</servertime>
</response></pre>

=== epg_next - depricated ===

Возвращает EPG на текущее время и на 3 последующих телепередачи канала с заданным ID.

Вызов:

'''/epg_next?cid=<id канала>'''

Входные параметры:

'''cid''' - Идентификатор канала, полученный из функции [[#channel_list|channel_list]]

Возвращает ответ вида:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
<epg>
  <item>
    <ts>TS</ts>
    <progname>PROGNAME </progname>
</item>
  </epg>
<servertime>SERVERTIME</servertime>
</response></pre>

Описание параметров ответа:

''ts'' - Дата и время начала передачи в формате Unixtime

''progname'' - Название передачи

Пример ответа:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
    <epg>
        <item>
            <ts>1423847100</ts>
            <progname>Дома на деревьях (Вид с высоты - 2) (12+)</progname>
            <pdescr/>
        </item>
        <item>
            <ts>1423850400</ts>
            <progname>Доминик Монаган и дикие существа (Серия 6) (12+)</progname>
            <pdescr/>
        </item>
        <item>
            <ts>1423853700</ts>
            <progname>Укротители аллигаторов (Аллигаторы обезумели) (12+)</progname>
            <pdescr/>
        </item>
    </epg>
    <servertime>1423846756</servertime>
</response></pre>

=== epg_current ===

Для вывода данных о текущем EPG нескольких каналов. Реализована для динамичной подгрузки данных EPG. Содержит время начала и конца передачи

Вызов: 

'''/epg_current?cids=<id1>[,<id3>[,<id3>[,...]]][&epg=<length>]'''

Входные параметры:

'''cids''' - Идентификатор канала(-ов), полученный из функции [[#channel_list|channel_list]]

'''epg''' - Количество передач, которые будут возвращены для указанных каналов, начиная с текущей

Ответ функции:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
<epg>
  <item>
    <cid>CID</cid>
    <epg>
      <epg_progname>EPG_PROGRAM </epg_progname>
      <epg_start>EPG_START</epg_start>
      <epg_end>EPG_STOP</epg_end>
    </epg>
  </item>
</epg>
<servertime>SERVERTIME</servertime>
</response></pre>

Описание параметров вответа

''cid'' - Идентификатор канала

''epg_progname'' - Название передачи

''epg_start'' -  Дата и время начала передачи в формате unixtime

''epg_end'' - Время окончания передачи в формате unixtime

Пример вызова: /epg_current?cids=2,5,7

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
    <epg>
        <item>
            <cid>155</cid>
            <epg>
                <epg_progname>Гангстеры дикой природы (Буйволы) (12+)</epg_progname>
                <epg_start>1423843800</epg_start>
                <epg_end>1423847100</epg_end>
            </epg>
        </item>
    </epg>
    <servertime>1423846855</servertime>
</response></pre>


При установленном параметре epg=3

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
    <epg>
        <item>
            <cid>155</cid>
            <epg>
                <epg_progname>Гангстеры дикой природы (Буйволы) (12+)</epg_progname>
                <epg_start>1423843800</epg_start>
                <epg_end>1423847100</epg_end>
            </epg>
            <epg>
                <epg_progname>Дома на деревьях (Вид с высоты - 2) (12+)</epg_progname>
                <epg_start>1423847100</epg_start>
                <epg_end>1423850400</epg_end>
            </epg>
            <epg>
                <epg_progname>Доминик Монаган и дикие существа (Серия 6) (12+)</epg_progname>
                <epg_start>1423850400</epg_start>
                <epg_end>1423853700</epg_end>
            </epg>
        </item>
    </epg>
    <servertime>1423846916</servertime>
</response></pre>

== Работа с "Любимыми каналами" ==

Набор функций был введен для совместимости со старым механизмом «любымих каналов». Идея состояла в том, что клиент мог бы запрограммировать свой пульт на 12 горячих кнопок для быст- рого доступа к любимым каналам. Как показала практика, идея себя не оправдала, поскольку ее реализация относится в большей мере к клиентской части и информация об выбранных клиентом каналах должна храниться на клиентском оборудовании.

=== favorites - deprecated ===

(Функция не обрабатывается на стороне API. Данный функционал должен быть на стороне клиента.)

Вызов любимых каналов. Организовано хранение 12 любимых каналов. Каждая ячейка именуется индексом place. В ней содержится идентификатор канала.

Вызов:

'''/favorites'''

Возвращает ответ вида:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
<favorites>
  <item>
       <place>PLACE</place>
       <channel_id>CHANNEL_ID</channel_id>
</item>
  </favorites>
<servertime>SERVERTIME</servertime>
</response></pre>

Описание параметров ответа:

''place'' - Номер ячейки

''channel_id'' - Идентификатор канала

''servertime'' - Время на сервере в формате unixtime

Пример:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
<favorites>
  <item>
       <place>2</place>
       <channel_id>2</channel_id>
  </item>
  <item>
       <place>8</place>
       <channel_id>3</channel_id>
  </item>
</favorites>
<servertime>1278944963</servertime>
</response></pre>

=== favorites_set - deprecated ===

(Функция не обрабатывается на стороне API. Данный функционал должен быть на стороне клиента.)

Устанавливает в заданную ячейку любимый канал. Если установить cid=0, то канал удалится из списка любимых.

Вызов:

'''/favorites_set?place=<номер ячейки для хранения>&cid=<идентификатор канала>'''

Входные параметры:

'''''place''''' - Номер ячейки для хранения любимого канала

'''''cid''''' - Идентификатор канала, полученный из функции [[#channel_list|channel_list]]


Возвращает ответ вида:

(пакет сообщение об успешном выполнении либо пакет ошибки)

=== settings ===


Получение значения переменной настройки.

Вызов: 

'''/settings?var=<http_caching|stream_server|timeshift|timezone|bitrate|bitratehd|archivebitratesd|archivebitratehd>'''

Если у переменной настройки есть список возможных значений, то они передаются в массиве с параметром list.

Входные параметры для функции:

'''''var''''' - ожидает передачи одного или нескольких параметров: 
<pre>
    http_caching     - время буферизации потока в миллисекундах

    stream_server    - IP сервера трансляции. Возможные значения передаются в массиве List

    timeshift        - смещение по времени. Возможные значения передаются в массиве List

    timezone         - часовой пояс. Возможные значения от -12 до +12

    bitrate          - Битрэйт для SD каналов

    bitratehd        - Битрэйт для HD каналов

    archivebitratesd - Битрэйт архива (VOD) SD каналов

    archivebitratehd - Битрэйт архива (VOD) HD каналов
</pre>
Возвращает ответ вида:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
    <settings>
        <name>bitrate</name>
        <value>Economy</value>
        <list>
            <item>Automatic</item>
            <item>Standart</item>
            <item>Economy</item>
        </list>
    </settings>
    <servertime>1423851019</servertime>
</response></pre>

Если у переменной настройки есть список возможных значений, то они передаются в массиве с параметром list.

=== settings_set ===

Установка значения переменной настройки.

Вызов: 

'''/settings_set?var=<pcode|http_caching|stream_server|timeshift|timezone|bitrate>&val=<значение>'''

Входные параметры:

'''''var''''' ожидает передачи одного или нескольких параметров. 

<pre>
    http_caching     - время буферизации потока в миллисекундах

    stream_server    - IP сервера трансляции. Возможные значения передаются в массиве List

    timeshift        - смещение по времени. Возможные значения передаются в массиве List

    timezone         - часовой пояс. Возможные значения от -12 до +12

    bitrate          - Битрэйт для SD каналов

    bitratehd        - Битрэйт для HD каналов

    archivebitratesd - Битрэйт архива (VOD) SD каналов

    archivebitratehd - Битрэйт архива (VOD) HD каналов
</pre>

== Видеотека ==

«Видео по требованию» Video-on-demand (VOD). Возможность просмотра файлов в режиме online из каталога. Отдельный раздел для абонента, где представлен набор фильмов, разделенный по категориям, жанрам, рейтингам и т.п.

=== vod_types ===

Получение списка типов видео-обьектов для фильтрации.

Вызов: 

'''/vod_types'''

Пример ответа:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
    <types>
        <id>2</id>
        <name>Фильмы</name>
    </types>
    <types>
        <id>tvseries</id>
        <name>Сериалы</name>
    </types>
    <servertime>1425402443</servertime>
</response>
</pre>

=== vod_list ===

Получение списка фильмов из базы видеотеки. Фильмы выводятся в порядке, заданном параметром type.

Вызов: 

'''/vod_list?[type=<best|last|text>[&query=<запрос>]][&page=<N>][&genre=<id_жанра>][&nums=<NN>][&vod_type=all|...>]'''

Входные параметры для функции:

'''''type''''' - best - лучшие фильмы согласно рейтинга по просмотрам; last - тот же список фильмов но отсортирован по дате добавления в обратном порядке; text - поиск в базе по названию фильма. Строка для поиска в query

'''''query''''' - Строка для поиска. Работает, если установлен параметр type=text

'''''page''''' - Номер страницы списка. По умолчанию установлен 1-й номер страницы.

'''''genre''''' - id - фильтр по жанрам. Показывает фильмы только указанного жанра. Возможно перечисление выводимых жанров через знак `|`. Например:
genre=205|206|215

'''''nums''''' -  Количество фильмов на страницу. По умолчанию: 20

'''''vod_type''''' - Тип видео записей для вывода all - все (значение по умолчанию all), остальные параметры фильтрации выбираются из функции [[#vod_types|vod_types]]


Возвращает ответ вида:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
<type>TYPE</type>
<total>TOTAL</total>
<count>COUNT</count>
<page>PAGE</page>
<rows>
  <item>
       <id>ID</id>
       <dt_modify>DT_MODIFY</dt_modify>
       <name>NAME </name>
       <name_orig>NAME_ORIG</name_orig>
       <description>DESCRIPTION</description>
       <poster>POSTER</poster>
       <year>YEAR</year>
       <rate_imdb>RATE_IMDB</rate_imdb>
       <rate_kinopoisk>RATE_KINOPOISK</rate_kinopoisk>
       <rate_mpaa>RATE_MPAA</rate_mpaa>
       <country>COUNTRY</country>
       <genre_str>детектив</genre_str>
</item> ...
<rows>
</response></pre>

Описание параметров ответа:

''type'' - текущий тип запроса

''total'' - всего записей, удовлетворяющих запросу

''count'' -  количество на текущей странице

''page'' - номер страницы

''id'' -  идентификатор фильма (не файла для вещания!)

''dt_modify'' - дата последней модификации (YYYY-MM-DD HH:MM:SS)

''name'' -  название фильма

''name_orig'' - оригинальное название фильма (если др.язык)

''description'' -  описание фильма

''poster'' - относительная ссылка на картинку постера. Относительно http://iptv.sunduk.tv/

''year'' -   год выпуска фильма

''rate_imdb'' - значение рейтинга IMDB 

''rate_kinopoisk'' -  значение рейтинга kinopoisk.ru

''rate_mpaa'' - значение рейтинга MPAA

''country'' -  страна производства

''genre_str'' - строка жанров (список жанров фильма собранный в строку и разделенные запятыми)


Пример ответа:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
    <type>best</type>
    <total>17</total>
    <count>17</count>
    <page>1</page>
    <rows>
        <id>32</id>
        <dt_modify>2014-11-25 09:41:05</dt_modify>
        <dt_create>2014-11-25 09:41:15</dt_create>
        <name>Укрощение строптивого</name>
        <name_orig>Il Bisbetico Domato (The Taming of the Scoundrel)</name_orig>
        <description>
            <p>Категорически не приемлющий женское общество грубоватый фермер (Адриано Челентано) вполне счастлив и
                доволен своей холостяцкой жизнью. Но неожиданно появившаяся в его жизни героиня (Орнелла Мути) пытается
                изменить его взгляды на жизнь и очаровать его. Что же из этого получится &hellip; Картина с успехом
                прошла в прокате и по сей день пользуется заслуженной любовью зрителей.
            </p>
        </description>
        <poster>/uploads/d2d0f77ff2fdfedeff07cd2cb963eca0.jpg</poster>
        <year>1980</year>
        <rate_imdb>7.5</rate_imdb>
        <rate_kinopoisk>8.339</rate_kinopoisk>
        <country>Италия</country>
        <vis>on</vis>
        <video_data>
            <items>
                <format>tv</format>
                <nums>1</nums>
            </items>
            <items>
                <format>dvd</format>
                <nums>1</nums>
            </items>
            <items>
                <format>fullhd</format>
                <nums>1</nums>
            </items>
        </video_data>
        <genre_str>комедия</genre_str>
        <pass_protect/>
    </rows>
    <rows>
        <id>3</id>
        <dt_modify>2014-11-25 09:41:05</dt_modify>
        <dt_create>2014-11-25 09:41:15</dt_create>
        <name>Амазония</name>
        <name_orig>Amazonia</name_orig>
        <description>
            <p>Невероятно увлекательное путешествие по диким тропическим джунглям Амазонии вместе с капуцином Саи. Выжив
                в авиакатастрофе, маленькая обезьянка попадает в необычную среду и теперь должна сама заботиться о себе.
                Ведь новый мир дикой природы полон опасностей и ловушек. Что ее ждет и как она приспособится к жизни в
                дикой Амазонии?
            </p>
        </description>
        <poster>/uploads/ec4d3bc6a57395f37fd8e5e16f82f20a.jpg</poster>
        <year>2013</year>
        <rate_imdb>6.714</rate_imdb>
        <rate_kinopoisk>10</rate_kinopoisk>
        <country>Франция</country>
        <vis>on</vis>
        <video_data>
            <items>
                <format>tv</format>
                <nums>1</nums>
            </items>
            <items>
                <format>dvd</format>
                <nums>1</nums>
            </items>
            <items>
                <format>fullhd</format>
                <nums>1</nums>
            </items>
        </video_data>
        <genre_str>документальный, приключения</genre_str>
        <pass_protect/>
    </rows>
    <servertime>1423853587</servertime>
</response>
</pre>

=== vod_info ===

Получение полной информации о фильме. 

Вызов:

'''/vod_info?id=<id фильма>[&protect_code=<родительский пароль>]'''

Входные параметры для функции:

'''''id''''' - идентификатор фильма, полученный из функции vod_list

'''''protect_code''''' - Родительский пароль, если фильм защищен протекцией от детей

Возвращает ответ вида:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
<film>
  <id>ID</id>
  <name>NAME</name>
  <name_orig>NAME_ORIG</name_orig>
  <description>DESCRIPTION</description>
  <poster>POSTER</poster>
  <length>LENGTH</length>
  <genre_str>GENRE_STR</genre_str>
  <year>YEAR</year>
  <director>DIRECTOR</director>
  <scenario>SCENARIO</scenario>
  <actors>ACTORS</actors>
 <rate_imdb>RATE_IMDB</rate_imdb>
 <rate_kinopoisk>RATE_KINOPOISK</rate_kinopoisk>
 <rate_mpaa>RATE_MPAA</rate_mpaa>
 <country>COUNTRY</country>
 <studio>STUDIO</studio>
 <awards>AWARDS</awards>
 <budget>BUDGET</budget>
 <images>IMAGES</images>
 <videos>
       <item>
         <id>ID</id>
         <title>TITLE</title>
         <format>fullhd</format>
         <url>URL</url>
         <size>SIZE</size>
         <length>LENGTH</length>
         <codec>CODEC</codec>
         <width>WIDTH</width>
         <height>HEIGTH</height>
         <track1_codec>TRACK1_CODEC</track1_codec>
         <track1_lang>TRACK1_LANG</track1_lang>
         <track2_codec>TRACK2_CODEC</track2_codec>
         <track2_lang>TRACK2_LANG</track2_lang>
         <track3_codec>TRACK3_CODEC</track3_codec>
         <track4_lang>TRACK3_LANG</track3_lang>
       </item>
  </videos>
  <genres>
       <item>
<id>ID</id>
         <name>NAME</name>
       </item>
  </genres>
</film>
<servertime>SERVERTIME</servertime>
</response></pre>

Описание параметров ответа:

''id'' - идентификатор фильма, полученный из функции vod_list

''name'' -  название фильма

''name_orig'' - оригинальное название фильма (если др.язык)

''description'' -  описание фильма

''poster'' - относительная ссылка на картинку постера. Относительно http://iptv.sunduk.tv/

''length'' - длина фильма в минутах

''genre_str'' -  жанры фильма, разделенные запятыми

''year'' - год выпуска

''director'' - режиссер

''scenario'' - сценарист

''actors'' -   в ролях 

''rate_imdb'' - значение рейтинга IMDB 

''rate_kinopoisk'' -  значение рейтинга kinopoisk.ru

''rate_mpaa'' - значение рейтинга MPAA

''country'' -  страна производства

''studio'' - студия

''awards'' -  награды

''budget'' - бюджет

''images'' -  скриншоты (если есть)

''password_protect'' - 1 или 0 закрыт или открыт контет по родительскому паролю. Устанавливается функцией /vod_manage

''videos'' -  файлы фильма (серии)

''videos/item/id'' - идентификатор файла

''title''  -  название серии. Если фильм односерийный, поле может быть не задано

''format'' - качество. economy|standart|hd|fullhd|3d (может быть перечислено несколько доступных форматов этого видео через запятую

''url'' -  имя файла (справочное, не используется.)

''size'' - размер файла

''codec'' - кодек

''width''  -   ширина картинки

''height'' - высота картинки

''track1_codec'' - аудио кодек дорожки 1

''track1_lang'' - язык звукового трека 1

''track2_codec'' -  аудио кодек дорожки 2

''track2_lang'' - язык звукового трека 2

''track3_codec'' -  аудио кодек дорожки 3

''track4_lang'' - язык звукового трека 3

''genres'' -   массив жанров фильма

''genres/id'' - идентификатор жанра

''genres/name'' - наименование жанра


Пример ответа:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
    <film>
        <id>3</id>
        <name>Амазония</name>
        <name_orig>Amazonia</name_orig>
        <description>
            <p>Невероятно увлекательное путешествие по диким тропическим джунглям Амазонии вместе с капуцином Саи. Выжив
                в авиакатастрофе, маленькая обезьянка попадает в необычную среду и теперь должна сама заботиться о себе.
                Ведь новый мир дикой природы полон опасностей и ловушек. Что ее ждет и как она приспособится к жизни в
                дикой Амазонии?
            </p>
        </description>
        <poster>uploads/ec4d3bc6a57395f37fd8e5e16f82f20a.jpg</poster>
        <lenght>82.533833333333</lenght>
        <genre_str>документальный, приключения</genre_str>
        <year>2013</year>
        <director>Тьерри Рагоберт</director>
        <scenario/>
        <actors></actors>
        <rate_imdb>6.714</rate_imdb>
        <rate_kinopoisk>10</rate_kinopoisk>
        <rate_mpaa/>
        <country>Франция</country>
        <studio/>
        <awards/>
        <budget/>
        <images/>
        <videos>
          <item>
            <id>2</id>
            <title>fullhd</title>
            <format>fullhd</format>
            <url>http://tv1.sunduk.tv:1935/vod/vod/vod/00/00/00/00/02.mp4/playlist.m3u8</url>
            <size>3763174739</size>
            <lenght>82.533833333333</lenght>
            <codec>h264, ac3</codec>
            <width>1920</width>
            <height>1080</height>
            <track1_codec>aac</track1_codec>
          </item>
        </videos>
        <genres>
            <id>8</id>
            <name>документальный</name>
        </genres>
        <genres>
            <id>18</id>
            <name>приключения</name>
        </genres>
    </film>
    <servertime>1423854433</servertime>
</response></pre>

=== Функция vod_geturl ===

Описание функции: получение ссылки для вещания потока видео.

Вызов: 

/vod_geturl?fileid=<ид файла>&format= economy | standart | hd | fullhd | 3d&protect_code=<родительский пароль>

Входные параметры для функции:

''fileid'' - идентификатор файла, полученный из функции vod_info

''protect_code'' - родительский пароль. Используется только для контента с пометкой <password_protect>

"format" - Качество которое должно быть передано если значение не передано то используется наилучшее качество
Возвращает ответ вида:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
    <url>http://tv1.sunduk.tv:1935/vod/vod/vod/00/00/00/00/03.mp4/playlist.m3u8</url>
    <servertime>1423854863</servertime>
</response></pre>

=== Функция vod_genres ===

Описание функции: возвращает список жанров. 

Вызов без параметров:

/vod_genres?vod_type=all | movie | tvseries...

"vod_type" -  Тип видео записей для вывода all - все (значение по умолчанию all), остальные параметры фильтрации выбираются из функции '''vod_types'''

Внимание! Не рекомендуется делать статичную копию справочника, поскольку жанры могут изменяться и появляться по мере поступления новых фильмов.

Возвращает ответ вида:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
<genres>
       <id>ID</id>
       <name>NAME</name>
...
<id>ID</id>
       <name>NAME</name>
</genres>
<servertime>SERVERTIME</servertime>
</response></pre>


''id'' - id жанра

''name'' - наименование жанра


Пример:

<nowiki /><pre><?xml version="1.0" encoding="UTF-8"?>
<response>
    <genres>
        <id>3</id>
        <name>боевик</name>
    </genres>
    <genres>
        <id>6</id>
        <name>детектив</name>
    </genres>
    <genres>
        <id>8</id>
        <name>документальный</name>
    </genres>

    <servertime>1423855163</servertime>
</response></pre>

=== Функция vod_favlist ===

Описание функции: выводит список отобранных любимых фильмов 

Вызов без параметров:

/vod_favlist

Формат ответа идентичен формату списка /vod_list

=== Функция vod_favadd ===

Описание функции: добавление фильма с идентификатором id в список любимых фильмов. 

Вызов:

/vod_favadd?id=<ID фильма>

=== Функция vod_favsub ===

Описание функции: удаление фильма с идентификатором id из списка любимых фильмов. 

Вызов:

/vod_favsub?id=<ID фильма>

== Коды ошибок ==

0 - Unknown error - Неизвестная ошибка

1 - Incorrect request - Неверный запрос

2 - Wrong login or password - Неправильный логин или пароль

3 - Access denied - Доступ запрещен

4 - Login incorrect - Неправильный логин

5 - Your contract is inactive - Ваш контракт неактивен

6 - Your contract is paused - Ваш контракт заморожен

7 - Channel not found or not allowed - Канал не найден или недоступен

8 - Error generate URL. Bad parameters - Ошибка генерации URL – заданы неверные параметры

9 - Need DAY parameter <DDMMYY> - Нужен параметр DAY

10 - Need Channel ID - Нужен ID канала

11 - Another client with your login was logged - Другой клиент вошел под Вашим логином

12 - Authentication error - Ошибка аутентификации

13 - Your packet was expired - Ваш пакет просрочен

14 - Unknown API function - Неизвестная функция API

15 - Archive is not available - Архив недоступен

16 - Need place to set - Необходимо установить в набор

17 - Need name of settings variable - Нужно название переменной установки

18 - Incorrect confirmation code - Неверный код подтверждения

19 - Current password is wrong - Текущий пароль неверен

20 - New password is wrong - Новый пароль неверен

21 - Need value (val) parameter - Необходим параметр val

22 - This value is not allowed - Это значение недопустимо

23 - Need parameter - Нужен параметр

24 - Need parameter <id> - Нужен параметр <id>

25 - Need parameter <fileid> - Нужен параметр < fileid >

26 - Need parameter <type> - Нужен параметр <type>

27 - Need parameter <query> - Нужен параметр <query>

28 - Need parameter <bitrate> - Нужен параметр < bitrate >

29 - Service is not available - Сервис недоступен

30 - Query limit exceeded - Исчерпан лимит запросов

31 - Rule already exist - Правило уже существует

32 - Need param ?cmd = hide_channel | show_channel | get_list - Нужен параметр ?cmd = hide_channel | show_channel | get_list

33 - Need param ?cmd = get_user_rates | set_user_rates - Нужен параметр ?cmd = get_user_rates | set_user_rates

34 - Bad rate value. Allow <show|hide|pass> - Неверное значение рейтинга

35 - Can’t find film - Невозможно найти фильм

36 - This film already added to favorite list - Этот фильм уже добавлен в список избранных

99 - System error - Ошибка системы


== Технические характеристики потока вещания ==

''Транспорт'' - HTTP/TS, HTTP

''Видео'' - Кодек -   H264 - MPEG-4 AVC (part 10) (h264)

                 Разрешение - 576x472, 720х576, 1280х720, 1920х1080

                 Частота кадров - 25

''Аудио'' - Кодек -  MPEG AAC Audio (mp4a)

                 Каналы - 1.0; 2.0; 2.1; 5.1

                 Частота дискретизации - 24000 Гц, 44100 Гц, 48000 Гц


== Ограничения ==

Существует ограничение на 5 запроса в секунду для одной сессии. Это вынужденная мера, введенная для защиты системы от избыточных перегрузок. В случае превышения этого лимита возвращается стандартный ответ ошибки с кодом 31 (Query limit exceeded).