API video.sibnet.ru
1. Все запросы, кроме загрузки новых роликов, выполняются на https://video.sibnet.ru/api/{метод_api}/.
2. Все запросы выполняются POST методом с передачей POST параметров.
3. Данные должны передаваться в кодировке UTF-8.
4. Все ответы в данный момент сервер отдает в JSON формате.
5. В каждом запросе необходимо передавать ключ доступа.
1. Базовая информация об API
URL запроса: https://video.sibnet.ru/api/info/
Параметры запроса:
key = 'ключ'
Ответ сервера:
[
{
"upload_url":"https://upload.virtvideo.sibnet.ru/upload_api.php",
"version":"0.0.1"
"about":"Sibnet Video API"
}
]
2. Работа с альбомами
2.1 Получить список альбомов
URL запроса: https://video.sibnet.ru/api/album/all/
Параметры запроса:
key = 'ключ'
Ответ сервера:
[
{
"id":"id_альбома",
"name":"название альбома",
"description":"описание альбома",
"publ":"видимость альбома другими",
"datecreate":"дата создания",
"img":"обложка альбома"
},
{
.
.
.
},
.
.
.
]
2.2 Получить список видео в альбоме:
URL запроса: https://video.sibnet.ru/api/album/list/
Параметры запроса:
key = 'ключ'
id = id_альбома
Ответ сервера:
[
{
"id":"id_видеоролика",
"name":"название видеоролика",
"description":"описание видеоролика",
"tags":"тэги видеоролика",
"albumid":"альбом видоролика",
"datecreate":"дата создания",
"cliptime":"длина видеоролика",
"img":"превью видеоролика",
"url":"адрес видеоролика",
"iframe":"код для вставки"
},
{
.
.
.
},
.
.
.
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
2.3 Создать новый альбом:
URL запроса: https://video.sibnet.ru/api/album/add/
Параметры запроса:
key = 'ключ'
name = 'название альбома'
description = 'описание альбома'
publ = публичность (0 - закрыт, 1 - открыт всем)
Ответ сервера:
[
{
"id":"id нового созданного альбома"
}
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
2.4 Изменить альбом:
URL запроса: https://video.sibnet.ru/api/album/update/
Параметры запроса:
key = 'ключ'
id = 'id альбома, который нужно измененить'
name = 'название альбома'
description = 'описание альбома'
publ = публичность (0 - закрыт, 1 - открыт всем)
Все поля необязательны. Т.е. можно изменить только имя, или, например, только приватность альбома.
Ответ сервера:
[
{
"id":"id измененного альбома"
}
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
2.5 Установить обложку для альбома на основе указанного видео:
URL запроса: https://video.sibnet.ru/api/album/cover/
Параметры запроса:
key = 'ключ'
id = 'id альбома, для которого устанавливается обложка'
videoid = 'id видеоролика, превью картинка которого станет обложкой альбома'
Ответ сервера:
[
{
"id":"id измененного альбома"
}
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
2.6 Удаление альбома вместе со всеми видеороликами из него:
URL запроса: https://video.sibnet.ru/api/album/delete/
Параметры запроса:
key = 'ключ'
id = 'id альбома, который нужно удалить'
Ответ сервера:
[
{
"id":"id удаленного альбома"
}
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
3. Работа с видеороликами
3.1 Получение url upload сервера перед загрузкой нового видеоролика:
URL запроса: https://video.sibnet.ru/api/getuploadurl/
Параметры запроса:
key = 'ключ'
Ответ сервера:
[
{
"upload_url":"url upload сервера, куда следует загружать новый видеоролик"
}
]
В данный момент upload сервер один всегда "https://upload.virtvideo.sibnet.ru/upload_api.php". Но следует делать этот запрос перед загрузкой. В дальнейшем кол-во upload серверов может увеличиться.
3.2 Получение списка базовых рубрик:
URL запроса: https://video.sibnet.ru/api/rubs/
Параметры запроса:
key = 'ключ'
Ответ сервера:
[
{
"id":"id рубрики",
"name":"название рубрики"
},
.
.
.
]
Каждый новый видеоролик должен быть привязан к одной базовой рубрике.
3.3 Загрузка нового видеоролика:
URL запроса: запрашивается через метод /api/getuploadurl/
Параметры запроса:
key = 'ключ'
name = 'название видеоролика'
description = 'описание видеоролика'
tags = 'тэги (метки) видеоролика. Разделяются по отдельным словам'
rubid = 'базовая рубрика видеоролика, полученная через метод /api/rubs/'
albumid = 'id альбома, в который загружается видеоролик'
video = @файл видеоролика
Ответ сервера:
[
{
"id":"id загруженного видеоролика",
"iframe":"код для вставки загруженного видеоролика на стороннем ресурсе",
"url":"url видеоролика на video.sibnet.ru"
},
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
3.4 Получение сведений о видеоролике:
URL запроса: запрашивается через метод /api/get/
Параметры запроса:
key = 'ключ'
id = 'id видеоролика'
url = 'url видеоролика'
Можно передавать либо id, либо url.
Ответ сервера:
[
{
"id":"id загруженного видеоролика",
"name":"название видеоролика",
"description":"описание видеоролика",
"tags":"тэги (метки) видеоролика",
"albumid":"id альбома, в котором находится видеоролик",
"datecreate":"дата создания видеоролика",
"cliptime":"длительность видеоролика",
"img":"првью изображение видеоролика",
"ctview":"кол-во просмотров у ролика"
"url":"url видеоролика на video.sibnet.ru",
"iframe":"код для вставки загруженного видеоролика на стороннем ресурсе"
},
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
3.5 Изменить видеоролик:
URL запроса: /api/update/
Параметры запроса:
key = 'ключ'
id = 'id видеоролика'
name = 'название видеоролика'
description = 'видеоролика'
tags = 'тэги (метки) видеоролика. Разделяются по отдельным словам'
rubid = 'базовая рубрика видеоролика, полученная через метод /api/rubs/'
albumid = 'другой альбом видеоролика, если необходимо сделать перенос'
Параметры необязательны. Будут изменены только те поля, что будут указаны в запросе.
Ответ сервера:
[
{
"id":"id измененного видеоролика",
},
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
3.6 Перезаливка видеоролика
В том случае, если необходимо перезалить видеоролик, необходимо выполнить 2 запроса к API
1. Запрос /api/updatevideofile/ подготавливает видоролик на сервере к перезаливке.
Параметры запроса:
key = 'ключ'
id = 'id видеоролика, который нужно перезалить'
Ответ сервера:
[
{
"upload_url":"url upload сервера, куда следует загружать новый видеоролик"
}
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
2. Запрос на URL, который вернет сервер в 1 запросе. Он же URL сервера загрузки. Только помимо файла видеоролика необходимо передавать еще id подготовленного видеоролика из запроса 1.
Если вдруг, после первого запроса на подготовку, не будет выполнен 2 запрос. То через какое-то время старый видеоролик вернется.
Параметры запроса:
key = 'ключ'
id = 'id видеоролика, котроый нужно перезалить'
video = @файл видеоролика
Ответ сервера:
[
{
"id":"id загруженного видеоролика",
"iframe":"код для вставки загруженного видеоролика на стороннем ресурсе",
"url":"url видеоролика на video.sibnet.ru"
},
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
3.7 Отключить блок поделиться (кнопка Share)
Для выполнения этой операции должны быть права, которые выдаются отдельно по запросу.
URL запроса: /api/updateshare/
Параметры запроса:
key = 'ключ'
id = 'id видеоролика, для которого нужно отключить блок поделиться'
share = 'флаг включения - 1 или выключения - 0. '
Ответ сервера:
[
{
"id":"id видеоролика с измененным параметром",
},
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
3.8 Удалить видеоролик:
URL запроса: /api/delete/
Параметры запроса:
key = 'ключ'
id = 'id видеоролика, который нужно удалить'
Ответ сервера:
[
{
"id":"id удаленного видеоролика",
},
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
4. Работа с плейлистами
4.1 Получить список плейлистов
URL запроса: https://video.sibnet.ru/api/playlist/all/
Параметры запроса:
key = 'ключ'
Ответ сервера:
[
{
"id":"id плейлиста",
"name":"название плейлиста",
"description":"описание плейлиста",
"publ":"видимость плейлиста другими",
"datecreate":"дата создания плейлиста",
},
{
.
.
.
},
.
.
.
]
4.2 Получить список видео в плейлисте:
URL запроса: https://video.sibnet.ru/api/playlist/list/
Параметры запроса:
key = 'ключ'
id = id плейлиста
Ответ сервера:
[
{
"id":"id_видеоролика",
"name":"название видеоролика",
"description":"описание видеоролика",
"tags":"тэги видеоролика",
"albumid":"альбом видоролика",
"datecreate":"дата создания",
"cliptime":"длина видеоролика",
"img":"превью видеоролика",
"url":"адрес видеоролика",
"iframe":"код для вставки"
},
{
.
.
.
},
.
.
.
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
4.3 Создать новый плейлист:
URL запроса: https://video.sibnet.ru/api/playlist/add/
Параметры запроса:
key = 'ключ'
name = 'название альбома'
description = 'описание альбома'
publ = публичность (0 - закрыт, 1 - открыт всем)
Ответ сервера:
[
{
"id":"id нового созданного плейлиста"
}
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
4.4 Изменить плейлист:
URL запроса: https://video.sibnet.ru/api/playlist/update/
Параметры запроса:
key = 'ключ'
id = 'id плейлиста, который нужно изменить'
name = 'название плейлиста'
description = 'описание плейлиста'
publ = публичность (0 - закрыт, 1 - открыт всем)
Все поля необязательны. Т.е. можно изменить только имя, или, например, только приватность плейлиста.
Ответ сервера:
[
{
"id":"id измененного плейлиста"
}
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
4.5 Удаление плейлиста:
URL запроса: https://video.sibnet.ru/api/playlist/delete/
Параметры запроса:
key = 'ключ'
id = 'id плейлиста, который нужно удалить'
Ответ сервера:
[
{
"id":"id удаленного плейлиста"
}
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
4.6 Добавить видеоролик в плейлист:
URL запроса: запрашивается через метод /api/playlist/addtoplaylist/
Параметры запроса:
key = 'ключ'
id = 'id плейлиста'
videoid = 'id видеоролика'
Ответ сервера:
[
{
"id":"id плейлиста",
"videoid":"id добавленного в плейлиста видеоролика"
},
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
4.7 Удалить видеоролик из плейлиста:
URL запроса: запрашивается через метод /api/playlist/deletefromplaylist/
Параметры запроса:
key = 'ключ'
id = 'id плейлиста'
videoid = 'id видеоролика'
Ответ сервера:
[
{
"id":"id плейлиста",
"videoid":"id удаленного из плейлиста видеоролика"
}
]
В случае ошибки ответ:
[
{
"error":"текст ошибки"
}
]
