SAPI: различия между версиями
Материал из OTV
Admin (обсуждение | вклад) (Новая страница: «Все запросы к API формируются по специально сформированному URL и имеют следущий вид: <pre> htt...») |
Admin (обсуждение | вклад) |
||
Строка 1: | Строка 1: | ||
Все запросы к API формируются по специально сформированному URL и имеют | =Описание= | ||
В данной статье описывается возможное взаимодействие между клиентом и сервером API. | |||
=Договоренности= | |||
* Все временные метки только в формате Unixtime | |||
* Boolean значение имеет следующее обозначение: положительное - 1, отрицательное - 0» | |||
* Кодировка UTF8. | |||
Все запросы к API формируются по специально сформированному URL и имеют следующий вид: | |||
<pre> | <pre> | ||
httр | httр://sapi.ott.st/v<api_version>/<type>/<method>?param1=value¶m2=value&token=<token> | ||
</pre> | </pre> | ||
Строка 25: | Строка 32: | ||
'''Пример запроса к API:''' | '''Пример запроса к API:''' | ||
<pre>httр://sapi.ott.st/v2.4/json/get_url?cid=1&token=sessiontoken</pre> | <pre>httр://sapi.ott.st/v2.4/json/get_url?cid=1&token=sessiontoken</pre> | ||
=Логотипы каналов= | |||
Получить логотип канала можно по следующему URL: | |||
<pre>http://ott.st/logos/<channel_id>.png</pre> | |||
Где '''<channel_id>''' - ID канала. | |||
=Методы= | |||
== [account] Аккаунт == | |||
===Описание метода=== | |||
Выводит информацию об аккаунте. | |||
===Формат запроса=== | |||
<pre>httр://sapi.ott.st/v2.4/xml/account?token=sessiontoken</pre> | |||
===Формат ответа=== | |||
<pre> | |||
<?xml version="1.0" encoding="utf-8"?> | |||
<response> | |||
<account> | |||
<login>[логин]</login> | |||
<tz>[таймзона]</tz> | |||
<first_name>[имя]</first_name> | |||
<last_name>[фамилия]</last_name> | |||
<city>[имя]</city> | |||
<country>[имя]</country> | |||
<packages> | |||
<item> | |||
<id>[id слуги]</id> | |||
<type>[тип услуги]</type> | |||
<name>[название услуги]</name> | |||
<expire>[время окончания подписки]</expire> | |||
</item> | |||
<item> | |||
<id>2</id> | |||
<type>1</type> | |||
<name>Базовый</name> | |||
<expire>1673108501</expire> | |||
</item> | |||
<item> | |||
<id>3</id> | |||
<type>1</type> | |||
<name>Взрослый</name> | |||
<expire>1523115026</expire> | |||
</item> | |||
... | |||
</packages> | |||
</account> | |||
<servertime>[время сервера]</servertime> | |||
</response> | |||
</pre> |
Версия 02:04, 8 января 2022
Описание
В данной статье описывается возможное взаимодействие между клиентом и сервером API.
Договоренности
- Все временные метки только в формате Unixtime
- Boolean значение имеет следующее обозначение: положительное - 1, отрицательное - 0»
- Кодировка UTF8.
Все запросы к API формируются по специально сформированному URL и имеют следующий вид:
httр://sapi.ott.st/v<api_version>/<type>/<method>?param1=value¶m2=value&token=<token>
<api_version> | Версия API. Текущая версия 2.4 |
<type> | Формат ответа API. Может принимать следующие параметры:
|
<method> | Метод API, описания которых предоставлены ниже. |
<token> | Уникальный ключ авторизации. Всегда равен md5(strtolower($login) . md5($password)) (пример на PHP) |
Пример запроса к API:
httр://sapi.ott.st/v2.4/json/get_url?cid=1&token=sessiontoken
Логотипы каналов
Получить логотип канала можно по следующему URL:
http://ott.st/logos/<channel_id>.png
Где <channel_id> - ID канала.
Методы
[account] Аккаунт
Описание метода
Выводит информацию об аккаунте.
Формат запроса
httр://sapi.ott.st/v2.4/xml/account?token=sessiontoken
Формат ответа
<?xml version="1.0" encoding="utf-8"?> <response> <account> <login>[логин]</login> <tz>[таймзона]</tz> <first_name>[имя]</first_name> <last_name>[фамилия]</last_name> <city>[имя]</city> <country>[имя]</country> <packages> <item> <id>[id слуги]</id> <type>[тип услуги]</type> <name>[название услуги]</name> <expire>[время окончания подписки]</expire> </item> <item> <id>2</id> <type>1</type> <name>Базовый</name> <expire>1673108501</expire> </item> <item> <id>3</id> <type>1</type> <name>Взрослый</name> <expire>1523115026</expire> </item> ... </packages> </account> <servertime>[время сервера]</servertime> </response>