HITMUSIC API V1

Материал из Документация GlobalArt
Перейти к: навигация, поиск

Использование

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

Узнать все доступные методы:

http://api.hitpleer.ru/v1?action=methods


Данная версия API возвращает ответ в формате JSON, все запросы на сервер передаются по этому адресу:

https://api.hitpleer.ru/v1?action=метод&параметры

Основные методы

  • stations - вывод всех станций [Любой ключ]
  • search - Поиск станций по совпадению [Любой ключ]
  • genres - вывод станций по жанру [Любой ключ]
  • track - вывод текущего трека [Любой ключ]
  • about - информация о станции [Любой ключ]
  • favorlist - список избранных станций [Любой ключ]
  • login - авторизация в системе [Ключ с уровнем доступа 1]
  • page - вывод страниц [Ключ с уровнем доступа 2]
  • radio - получение потока станции [Любой ключ]

Использование методов

метод stations (GET)
  • параметры:
  1. page - количество станций на странице от 1 до 100
  2. current - номер текущей страницы, первая страница - это 0

Параметры

Переменная Тип Переменная Тип
count integer name string
stations object genre_id string
id integer bitrate integer
image string order integer
audio_url string website string

Пример вывода:

{
     "count": 1,
     "stations": [
     {
       "id": 1,
       "image": "/uploads/content/nHRH.jpg",
       "url": "radio-classic",
       "audio_url": "http://cfm.jazzandclassic.ru:14534/rcstream64.mp3",
       "name": "Радио классик",
       "genre_id": "Класика",
       "bitrate": 128,
       "website": "",
       "order": 44
     } ... ]
}
метод search (GET)
  • параметры
  1. stext - название радиостанции.
Переменная Тип Переменная Тип
count integer name string
stations object genre_id string
id integer bitrate integer
is_visible integer website string
image string order integer
audio_url string - -

Пример вывода:

{
     "count": 2,
     "stations": [
     {
       "id": 1,
       "is_visible": 1,
       "image": "/uploads/content/sYKa.jpg",
       "url": "energy",
       "audio_url": "http://ic7.101.ru:8000/v1_1",
       "name": "Энерджи (NRJ)",
       "genre_id": "Электронная музыка",
       "bitrate": 320,
       "website": "http://energyfm.ru",
       "order": 1
     },
     {
       "id": 14,
       "is_visible": 1,
       "image": "/uploads/content/eHeS.jpg",
       "url": "nrk-sami",
       "audio_url": "http://lyd.nrk.no/nrk_radio_sami_mp3_h",
       "name": "NRJ Sami Radio",
       "genre_id": "Шансон",
       "bitrate": 128,
       "website": "",
       "order": 13
     }, ... ]
}
метод genres (GET)
  • параметры
  1. genre - url-адрес жанра, например: pop
Переменная Тип Переменная Тип
count integer audio_url string
stations object name string
id integer genre_id string
image string bitrate integer
url string order integer

Пример вывода:

{
     "count": 2,
     "stations": [
     {
       "id": 29,
       "image": "/uploads/content/09082018090529-5b6bd9a94d083.jpg",
       "url": "mega-radio",
       "audio_url": "http://stream.megaradio.pro/MegaRadio",
       "name": "Мега радио",
       "genre_id": "Поп",
       "bitrate": 128,
       "order": 26
     },
     {
       "id": 30,
       "image": "/uploads/content/09082018090718-5b6bda1687f6d.jpg",
       "url": "gomel-fm",
       "audio_url": "http://s1.radioheart.ru:8001/radiogomelfm",
       "name": "Гомель FM",
       "genre_id": "Поп",
       "bitrate": 128,
       "order": 27
     }, ... ]
}
метод track (GET)
  • параметры
  1. id - идентификатор станции, целочисленное число
Переменная Тип
name string

Пример вывода:

{
     "name": "JASON DONOVAN - SEALED WITH A KISS"
}
метод about (GET)
  • параметры
  1. url - url адрес станции
  2. state - необязательный параметр, если страница уже открыта.
Переменная Тип Переменная Тип
station object audio_url string
id integer name string
is_visible integer genre_id string
image string bitrate integer
url string website string

Пример вывода:

{
     "station": {
       "id": 1,
       "is_visible": 1,
       "image": "/uploads/content/sYKa.jpg",
       "url": "energy",
       "audio_url": "http://ic7.101.ru:8000/v1_1",
       "name": "Энерджи (NRJ)",
       "genre_id": "Электронная музыка",
       "bitrate": 320,
       "website": "http://energyfm.ru",
       "desc": "",
       "order": 1
     }
}

метод login (POST)

  • параметры
  1. email - адрес электронной почты пользователя
  2. password - пароль пользователя

примечание: значение action_key лучше сохранить в кэше устройства или в сессии.

Переменная Тип
success integer
action_key string
message string

Пример вывода:

{
    "success":1,
    "action_key":"40d1f5319145743efee3f4b3af06d131",
    "message":"user_authorized"
}

метод favorlist (GET)

  • параметры
  1. action_key - ключ, который получен после авторизации
{
    "st_id": 0,
    "stations": [
    {
        "id": 4,
        "is_visible": 1,
        "image": "/uploads/content/eetD.jpg",
        "url": "radio-record",
        "audio_url": "http://air.radiorecord.ru:805/rr_320",
        "name": "Радио Рекорд",
        "genre_id": "Электронная музыка",
        "bitrate": 320,
        "website": "",
        "desc": "",
        "order": 5
    },
    {
        "id": 1,
        "is_visible": 1,
        "image": "/uploads/content/sYKa.jpg",
        "url": "energy",
        "audio_url": "http://ic7.101.ru:8000/v1_1",
        "name": "Энерджи (NRJ)",
        "genre_id": "Электронная музыка",
        "bitrate": 320,
        "website": "http://energyfm.ru",
        "desc": "",
        "order": 1
    }, ... ]
}

метод page (GET)

  • параметры
  1. url - адрес страницы
Переменная Тип
id integer
slug string
name string
text text

Пример вывода:

{
    "id":1,
    "slug":"copyright",
    "name":"Правовая информация",
    "text":"содержимое страницы"
}

метод radio (GET)

  • параметры
  1. id - идентификатор радио
Переменная Тип
audio_url string

Пример вывода:

{
    "audio_url":"http://ep128.hostingradio.ru:8030/ep128"
}

метод favor-add (POST)

  • параметры
  1. action_key - ключ, который получен после авторизации
  2. id - идентификатор станции
Переменная Тип
success integer
message string

Пример вывода:

{
    "success":1,
    "message":"station_is_added"
}

метод favor-del (POST)

  • параметры
  1. action_key - ключ, который получен после авторизации
  2. id - идентификатор станции
Переменная Тип
success integer
message string

Пример вывода:

{
    "success":1,
    "message":"station_is_deleted"
}