For developers


api/oauth

1. Открытие диалога авторизации – https://tviply.com/api/oauth

Параметры:

  • client_id – Идентификатор Вашего приложения.
  • redirect_uri – Адрес, на который будет переадресован пользователь после прохождения авторизации.

Пример запроса:

https://tviply.com/api/oauth?client_id=1&redirect_uri=https://example.tv/oauth_back

Если пользователь не вошел на сайт, то в диалоговом окне ему будет предложено ввести свой логин и пароль.

2. Получение code

После успешной авторизации приложения браузер пользователя будет перенаправлен по адресу redirect_uri, указанному при открытии диалога авторизации.
При этом код для получения ключа доступа code будет передан как GET-параметр:

https://example.tv/oauth_back?code=67c5e3b9f3d2fad016b4cee7c7b9c711

3. Получение access_token

Для получения access_token необходимо выполнить запрос с Вашего сервера на https://tviply.com/api/access_token, передав следующие параметры:

Параметры:

  • client_id – Идентификатор Вашего приложения.
  • client_secret – Секретный ключ Вашего приложения.
  • redirect_uri – Адрес, который использовался при получении code на первом этапе авторизации.
  • code – Временный код, полученный после прохождения авторизации.

Пример запроса:

https://tviply.com/api/access_token?client_id=1&client_secret=2a8ccfd229e40c67a013d9024a129c09e5f9402258e427207cab5aaba6829d69&redirect_uri=https://example.tv/oauth_back&code=67c5e3b9f3d2fad016b4cee7c7b9c711

Email и ключ доступа к методам API access_token будет передан в ответе запроса.


api/users

Возвращает информацию о пользователях.

api/users/param

Параметры:

  • api/users/param – может быть self, id или name пользователя.
  • token – access_token который получили тут

Пример запроса:

curl https://tviply.com/api/users/self?token=access_token

api/channels

Возвращает информацию о каналах.

api/channels/param

Параметры:

  • param – может быть id канала
  • token – access_token который получили тут

Пример запроса:

curl https://tviply.com/api/channels/1?token=access_token

api/channels/likes

Возвращает список подписанных каналов пользователя.

api/channels/likes

Параметры:

  • token – access_token который получили тут

Пример запроса:

curl https://tviply.com/api/channels/likes?token=access_token

api/channels/on-air

Возвращает список каналов в прямом эфире.

api/channels/on-air

Параметры:

  • token – access_token который получили тут

Пример запроса:

curl https://tviply.com/api/channels/on-air?token=access_token

api/channels/rtmpSecret

Возвращает хост и ключ канала пользователя. Недоступно для всех в текущей версии api.

api/channels/rtmpSecret

Параметры:

  • token – access_token который получили тут

Пример запроса:

curl https://tviply.com/api/channels/on-air?token=access_token

api/channels/stats

Возвращает статистику трансляции.

api/channels/stats/id

Параметры:

  • id – id статистики
  • token – access_token который получили тут

Пример запроса:

curl https://tviply.com/api/channels/stats/id?token=access_token

api/channels/like

Подписывает или отписывает канал и возвращает состояние.

api/channels/like/id/check

Параметры:

  • id – id канала
  • check – если указать, вернет только состояние
  • token – access_token который получили тут

Пример запроса:

curl https://tviply.com/api/channels/like/1?token=access_token

api/channels/chatting

Возвращает список пользователей в чате.

api/channels/chatting/id

Параметры:

  • id – id канала

Пример запроса:

curl https://tviply.com/api/channels/chatting/1

api/chat/sendMessage

Отправляет сообщение в чате.

POST api/chat/sendMessage

Параметры:

  • channelId – id канала
  • message – текст сообщения
  • token – access_token который получили тут

Пример запроса:

curl --data "channelId=1&message=Curl test message from api&token=access_token" https://tviply.com/api/chat/sendMessage

api/chat/sendVoice

Отправляет звуковое сообщение в чате.

POST api/chat/sendVoice

Параметры:

  • channelId – id канала
  • voice – post file attachment, type: audio/ogg, max size: 1 MB
  • token – access_token который получили тут

Пример запроса:

curl -F "channelId=1" -F "voice=@/file/to/voice.ogg" -F "token=access_token" https://tviply.com/api/chat/sendVoice

api/chat/colorChat

Изменяет цвет имени в чате.

POST api/chat/colorChat/color?token=access_token

Параметры:

  • color – hex 6 chars
  • token – access_token который получили тут

Пример запроса:

curl https://tviply.com/api/chat/colorChat/888888?token=access_token

api/search

Поиск по каналам.

POST api/search

Параметры:

  • query – текст поиска

Пример запроса:

curl -F "query=Dev" https://tviply.com/api/search