AIR API / Radioheart AIR / Помощь

Перейти к разделу

Список разделов Начало работы Биллинг Radioheart Air Радиовещание Веб-хостинг

AIR API

Платформа Radioheart AIR обладает широким набором инструментов для вывода различной информации на сайт или публичную страницу радиостанции.

При помощи готовых скриптов и виджетов наши клиенты могут добавлять на сайт различную информацию о треках в эфире станции, получать ссылки на прослушивание и/или скачивание треков из панели прямо с сайта станции, осуществлять прием заказов песен слушателями и передачу сообщений.

API предоставляется для всех клиентов хостинга по умолчанию. Набор инструментов постоянно расширяется и улучшается при участии наших клиентов.

Для полноценного использования описанных в данной статье инструментов вещание станции должно осуществляться через нашу платформу Radioheart AIR. При вещании из сторонних программ виджеты для вывода информации на сайт работать не будут.

Доступ к API и описание инструментов

Чтобы приступить к работе с API перейдите раздел «Приложения» в биллинге. Все инструменты для работы с API расположены в подразделах «Конструктор скриптов» и «Виджеты».

Чтобы сгенерировать код скриптов или виджетов требуется указать услугу радиохостинга. Как правило, она уже выбрана в списке.

С помощью конструктора скриптов можно сгенерировать скрипт для того, чтобы вывести на сайт станции необходимые данные — название и описание потока, количество слушателей, название текущего трека, фото исполнителя или аватар диджея.

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

Конструктор скриптов

Конструктор скриптов позволяет сгенерировать скрипт под ваши нужды для того, чтобы вывести на сайт станции необходимые данные — название и описание потока, количество слушателей, название текущего трека, фото исполнителя или аватар диджея.

Доступно две версии скрипта — PHP и Javascript. Рекомендуем использовать PHP-версию, однако, она может не работать на бесплатном хостинге (где расположен ваш сайт).

Генерация и добавление скрипта на сайт станции

Для того, чтобы сгенерировать скрипт для сайта перейдите в раздел «Приложения» > «Конструктор скриптов».

Выберите услугу для создания скрипта, тип скрипта и пункты для отображения информации, после чего нажмите «Сгенерировать скрипт».

Откроется инструкция для добавления скрипта на сайт. Следуйте инструкции для подключения файлов скрипта.

Если у вас возникли трудности или ошибки при добавлении скрипта на свой сайт, создайте запрос в «Поддержке».

Получение списка песен, загрузка и проигрывание файлов из автодиджея

Для вывода списка загруженных треков на сайт, а также для их проигрывания и скачивания, существуют методы «Список файлов в автодиджее» и «Получение файла из автодиджея».

Список файлов в автодиджее

Метод «Список файлов в автодиджее» предназначен для получения списка файлов, которые загружены в автодиджей.

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

aN.radioheart.ru — IP-адрес сервера, где располагается ваш автодиджей.

userlogin — логин пользователя, для которого запрашивается метод. Является обязательным параметром.

api=filesList — название вызываемого метода. Является обязательным параметром.

limit — задает количество треков для получения. По умолчанию не задано (все треки)

folder — задает папку, из которой надо получить треки. По умолчанию — / (корень)

JSON-запрос:

Пример использования на PHP:

Получение файла из автодиджея

Метод «Получение файла из автодиджея» предназначен для получения на проигрывание или скачивание файла из автодиджея.

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

aN.radioheart.ru — IP-адрес сервера, где располагается ваш автодиджей.

userlogin — логин пользователя, для которого запрашивается метод. Является обязательным параметром.

api=getFile — название вызываемого метода. Является обязательным параметром.

id — ID трека из прошлого запроса (список файлов). Является обязательным параметром.

JSON-запрос:

Пример использования на PHP:

Прием заказов песен от слушателей

Заказ треков слушателями радиостанции осуществляется с сайта или публичной страницы (мини-сайта) станции. Для приема заявок следует настроить заказ треков и добавить соответствующий виджет на сайт. С помощью данного виджета слушатели вашей станции смогут выбирать треки из музыкальной базы и заказывать их. Заказанные треки попадают в очередь эфира.

О том как работает и настраивается прием заказов читайте в разделе «Заказ треков слушателями». Здесь же мы разберем виджеты, необходимые для того, чтобы осуществлять прием заказов с сайта.

Метод «Виджет заказа треков, с возможностью передачи сообщения» предназначен для вывода на сайт списка треков, доступных для заказа. Заказ треков настраивается в панели управления эфиром.

В виджете присутствует поиск по базе треков, а также есть возможность прикрепить сообщение при заказе трека (данную возможность можно выключить в настройках приема заказов).

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

aN.radioheart.ru — IP-адрес сервера, где располагается ваш автодиджей.

userlogin — логин пользователя, для которого запрашивается метод. Является обязательным параметром.

api=newsongorder — название вызываемого метода. Является обязательным параметром.

Интеграция с сайтом в модальном окне. Подключаем файл стилей для модальных окон между тегами <head> и </head>, если он у вас еще не подключен:

Добавляем HTML-код в любом месте сайта, желательно между тегами <body> и </body>:

Метод «Топ заказов автодиджея» предназначен для получения списка наиболее популярных треков, которые заказывают слушатели с вашего сайта, используя виджет заказа треков.

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

aN.radioheart.ru — IP-адрес сервера, где располагается ваш автодиджей.

userlogin — логин пользователя, для которого запрашивается метод. Является обязательным параметром.

api=toporders — название вызываемого метода. Является обязательным параметром.

count устанавливает количество песен, которые будут получены из автодиджея. Значение по умолчанию = 5.

color задает цвет текста, которым будет выведена информация. Значение по умолчанию = 010101.

fontsize задает размер шрифта в пикселях. Значение по умолчанию = 14 пикселей.

fontfamily задает гарнитуру шрифта. Значение по умолчанию = Calibri.

Примеры использования:

Запрос с параметрами по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=toporders

Запрос на 10 треков, с цветом текста по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=toporders&count=10

Запрос с изменением цвета, количество песен по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=toporders&color=f2f2f2

Запрос с изменением числа песен, цвета, шрифта и размера текста:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=toporders&color=f2f2f2&fontsize=16&count=10&fontfamily=Arial

JSON-запрос:

Пример использования на PHP:

Пример использования на HTML:

Интеграция с сайтом в модальном окне. Подключаем библиотеку Jquery между тегами <head> и </head>, если она у вас еще не подключена:

Подключаем файл стилей и библиотеку для создания модальных окон между тегами <head> и </head>, если они у вас еще не подключены::

Добавляем функцию, которая инициализирует модальное окно между тегами <head> и </head>:

Выводим ссылку, по нажатию на которую будет открываться наше модальное окно: <head> и </head>:

Вывод списков треков на сайт

Существует несколько виджетов, предназначенных для вывода на сайт списков треков. Можно вывести на сайт последние проигранные треки (историю эфира), следующие треки (которые будут в эфире после текущего), а также новые (последние загруженные в панель) треки.

Список следующих треков

Метод «Список следующий треков» предназначен для получения списка следующих треков из автодиджея.

Данный метод не будет работать корректно при включенном режиме рандома. Читайте подробнее — «Режим рандома (проигрывание в случайном порядке)».

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

aN.radioheart.ru — IP-адрес сервера, где располагается ваш автодиджей.

userlogin — логин пользователя, для которого запрашивается метод. Является обязательным параметром.

api=nexttrack — название вызываемого метода. Является обязательным параметром.

count устанавливает количество песен, которые будут получены из автодиджея. Значение по умолчанию = 5.

color задает цвет текста, которым будет выведена информация. Значение по умолчанию = 010101.

fontsize задает размер шрифта в пикселях. Значение по умолчанию = 14 пикселей.

fontfamily задает гарнитуру шрифта. Значение по умолчанию = Calibri.

Примеры использования:

Запрос с параметрами по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=nexttrack

Запрос на 10 треков, с цветом текста по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=nexttrack&count=10

Запрос с изменением цвета, количество песен по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=nexttrack&color=f2f2f2

Запрос с изменением числа песен, цвета, шрифта и размера текста:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=nexttrack&color=f2f2f2&fontsize=16&count=10&fontfamily=Arial

JSON-запрос:

Пример использования на PHP:

Пример использования на HTML:

Добавляем функцию, которая инициализирует модальное окно между тегами <head> и </head>:

Выводим ссылку, по нажатию на которую будет открываться наше модальное окно: <head> и </head>:

Список последних треков

Метод «Список последних треков» предназначен для получения списка песен, которые недавно звучали в эфире.

Наша платформа умеет скрывать из истории треков рекламу, джинглы, а также другие отмеченные файлы. Читайте подробнее — «Скрытие рекламы и джинглов из плейлиста станции».

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

aN.radioheart.ru — IP-адрес сервера, где располагается ваш автодиджей.

userlogin — логин пользователя, для которого запрашивается метод. Является обязательным параметром.

api=lasttrack — название вызываемого метода. Является обязательным параметром.

count устанавливает количество песен, которые будут получены из автодиджея. Значение по умолчанию = 5.

color задает цвет текста, которым будет выведена информация. Значение по умолчанию = 010101.

fontsize задает размер шрифта в пикселях. Значение по умолчанию = 14 пикселей.

fontfamily задает гарнитуру шрифта. Значение по умолчанию = Calibri.

Примеры использования:

Запрос с параметрами по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=lasttrack

Запрос на 10 треков, с цветом текста по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=lasttrack&count=10

Запрос с изменением цвета, количество песен по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=lasttrack&color=f2f2f2

Запрос с изменением числа песен, цвета, шрифта и размера текста:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=lasttrack&color=f2f2f2&fontsize=16&count=10&fontfamily=Arial

JSON-запрос:

Пример использования на PHP:

Пример использования на HTML:

Добавляем функцию, которая инициализирует модальное окно между тегами <head> и </head>:

Выводим ссылку, по нажатию на которую будет открываться наше модальное окно: <head> и </head>:

Список новых треков

Метод «Список новых треков» предназначен для получения списка новых треков из автодиджея. Сортировка производится по дате загрузке файлов в автодиджей.

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

aN.radioheart.ru — IP-адрес сервера, где располагается ваш автодиджей.

userlogin — логин пользователя, для которого запрашивается метод. Является обязательным параметром.

api=newsongs — название вызываемого метода. Является обязательным параметром.

count устанавливает количество песен, которые будут получены из автодиджея. Значение по умолчанию = 5.

color задает цвет текста, которым будет выведена информация. Значение по умолчанию = 010101.

fontsize задает размер шрифта в пикселях. Значение по умолчанию = 14 пикселей.

fontfamily задает гарнитуру шрифта. Значение по умолчанию = Calibri.

days задает количество дней за которые берутся песни.

folders задает папки для получения песен. Значения перечисляются через запятую.

Примеры использования:

Запрос с параметрами по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=newsongs

Запрос на 10 треков, с цветом текста по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=newsongs&count=10

Запрос с изменением цвета, количество песен по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=newsongs&color=f2f2f2

Запрос с изменением числа песен, цвета, шрифта и размера текста:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=newsongs&color=f2f2f2&fontsize=16&count=10&fontfamily=Arial

JSON-запрос:

Пример использования на PHP:

Пример использования на HTML:

Добавляем функцию, которая инициализирует модальное окно между тегами <head> и </head>:

Выводим ссылку, по нажатию на которую будет открываться наше модальное окно: <head> и </head>:

Треки в эфире

Метод «Список новых треков» представляет собой комбинацию списка следующих и предыдущих треков.

Данный виджет также показывает трек, звучащий в данный момент (на основе виджета прошлых треков).

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

aN.radioheart.ru — IP-адрес сервера, где располагается ваш автодиджей.

userlogin — логин пользователя, для которого запрашивается метод. Является обязательным параметром.

api=newsongs — название вызываемого метода. Является обязательным параметром.

count устанавливает количество песен, которые будут получены из автодиджея. Значение по умолчанию = 5.

color задает цвет текста, которым будет выведена информация. Значение по умолчанию = 010101.

fontsize задает размер шрифта в пикселях. Значение по умолчанию = 14 пикселей.

fontfamily задает гарнитуру шрифта. Значение по умолчанию = Calibri.

Интеграция с сайтом в модальном окне. Подключаем файл стилей для модальных окон между тегами <head> и </head>, если он у вас еще не подключен:

Добавляем HTML код в любом месте сайта, желательно между тегами <body> и </body>:

Выводим в нужном месте ссылку, по нажатию на которую будет открываться модальное окно виджета:

Вывод текущего и запланированных плейлистов на сайт

С помощью виджетов для вывода плейлистов можно отобразить на сайте название играющего в данный момент плейлиста, а также вывести расписание на основе запланированных плейлистов.

Список запланированных плейлистов (вывод расписания)

Метод «Список запланированных плейлистов (вывод расписания)» предназначен для получения списка запланированных плейлистов (расписания).

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

aN.radioheart.ru — IP-адрес сервера, где располагается ваш автодиджей.

userlogin — логин пользователя, для которого запрашивается метод. Является обязательным параметром.

api=scheduler — название вызываемого метода. Является обязательным параметром.

count устанавливает количество песен, которые будут получены из автодиджея. Значение по умолчанию = 5.

color задает цвет текста, которым будет выведена информация. Значение по умолчанию = 010101.

fontsize задает размер шрифта в пикселях. Значение по умолчанию = 14 пикселей.

fontfamily задает гарнитуру шрифта. Значение по умолчанию = Calibri.

year задает год, на который запланирован плейлист. Значение по умолчанию = текущий год.

month задает месяц, на который запланирован плейлист. Значение по умолчанию = текущий месяц.

day задает день, на который запланирован плейлист. Значение по умолчанию = текущий день.

Примеры использования:

Запрос с параметрами по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=scheduler

Запрос на 10 треков, с цветом текста по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=scheduler&count=10

Запрос с изменением цвета, количество песен по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=scheduler&color=f2f2f2

Запрос с изменением числа песен, цвета, шрифта и размера текста:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=scheduler&color=f2f2f2&fontsize=16&count=10&fontfamily=Arial

Запрос с изменением даты, на которую запланированы плейлисты:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=scheduler&year=2014&month=9&day=30

JSON-запрос:

Пример использования на PHP:

Пример использования на HTML:

Добавляем функцию, которая инициализирует модальное окно между тегами <head> и </head>:

Выводим ссылку, по нажатию на которую будет открываться наше модальное окно: <head> и </head>:

Название плейлиста в эфире

Метод «Название плейлиста в эфире» предназначен для получения названия плейлиста, который сейчас находится в эфире.

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

aN.radioheart.ru — IP-адрес сервера, где располагается ваш автодиджей.

userlogin — логин пользователя, для которого запрашивается метод. Является обязательным параметром.

api=current_pl — название вызываемого метода. Является обязательным параметром.

count устанавливает количество песен, которые будут получены из автодиджея. Значение по умолчанию = 5.

color задает цвет текста, которым будет выведена информация. Значение по умолчанию = 010101.

fontsize задает размер шрифта в пикселях. Значение по умолчанию = 14 пикселей.

fontfamily задает гарнитуру шрифта. Значение по умолчанию = Calibri.

Примеры использования:

Запрос с параметрами по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=current_pl

Запрос на 10 треков, с цветом текста по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=current_pl&count=10

Запрос с изменением цвета, количество песен по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=current_pl&color=f2f2f2

Запрос с изменением числа песен, цвета, шрифта и размера текста:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=current_pl&color=f2f2f2&fontsize=16&count=10&fontfamily=Arial

JSON-запрос:

Пример использования на PHP:

Пример использования на HTML:

Добавляем функцию, которая инициализирует модальное окно между тегами <head> и </head>:

Выводим ссылку, по нажатию на которую будет открываться наше модальное окно: <head> и </head>:

Вывод текущего времени на сайт

Метод «Виджет текущего времени на сервере» предназначен для получения текущего времени на сервере автодиджея во временной зоне автодиджея.

Часовой пояс, по которому работает станция, настраивается в настройках панели. Читайте подробнее — «Настройки панели».

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

aN.radioheart.ru — IP-адрес сервера, где располагается ваш автодиджей.

userlogin — логин пользователя, для которого запрашивается метод. Является обязательным параметром.

api=current_time — название вызываемого метода. Является обязательным параметром.

color задает цвет текста, которым будет выведена информация. Значение по умолчанию = 010101.

fontsize задает размер шрифта в пикселях. Значение по умолчанию = 14 пикселей.

fontfamily задает гарнитуру шрифта. Значение по умолчанию = Calibri.

format задает формат даты и времени для вывода.
Значние по умолчанию = d.m.Y H:i:s

Примеры использования:

Запрос с параметрами по умолчанию:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=current_time

Запрос с изменением цвета:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=current_time&color=f2f2f2

Запрос с изменением цвета, шрифта и размера текста:
https://aN.radioheart.ru/api/html?userlogin=user8000&api=current_time&color=f2f2f2&fontsize=16&fontfamily=Arial

JSON-запрос:

Пример использования на PHP:

Пример использования на HTML:

Превышение запросов к API

Существует ограничение на 100 запросов в минуту с одного IP-адреса на один метод API. В случае превышения количества запросов появляется ошибка «Too many requests». Данное ограничение действует для всех версий панели и для всех пользователей.

Для Lite-версии панели отсутствуют дополнительные ограничения на количество запросов, однако, при сильной нагрузке, доступ к API может быть на время заблокирован.

Перейти в раздел

К списку статей

Не нашли ответа?

Спросите то, что вас интересует

Написать нам