379
edits
Changes
Новая страница: «==Общее описание API== Запросы API отправляются на адрес <tt><nowiki>https://api-dev.acestream.net</nowiki></tt> методо…»
==Общее описание API==
Запросы API отправляются на адрес <tt><nowiki>https://api-dev.acestream.net</nowiki></tt> методом HTTP-GET.
Ответы на запросы приходят в формате json.
Если при обработке запроса возникла ошибка, будет отослан ответ такого вида:
<tt><nowiki>{"error":"error descrtiption"}</nowiki></tt>
Ответы за успешно обработанные запросы зависят от вызываемого метода.
===Обязательные общие параметры для всех запросов===
* '''method''' - вызываемый метод API
* '''api_key''' - ключ клиента API
* '''api_version''' - поддерживаемая версия API (текущая версия: 1.0)
* '''sign''' - цифровая подпись запроса
===Алгоритм формирования цифровой подписи===
* создается массив строк вида "название_параметра=значение_параметра"
* полученный массив сортируется
* элементы отсортированного массива объединяются в строку с разделителем "#"
* к полученной строке добавляется секретный ключ клиента API
* подписью является sha1-хеш от полученной строки (в шестнадцатеричном представлении, 40 символов, маленькими буквами)
Код на PHP:
<tt><nowiki>function makeSignature(array $params, $apiSecret)
{
$checkParams = array();
foreach($params as $k => $v) {
$checkParams[] = $k . '=' . $v;
}
sort($checkParams);
$payload = join('#', $checkParams);
$sign = sha1($payload . $apiSecret);
return $sign;
}</nowiki></tt>
==Методы API==
===getServiceCost===
Получить стоимость услуги
параметры:
* '''service''' (''string'') - идентификатор услуги
* '''period''' (''string'') - идентификатор периода
поля в ответе:
* '''cost''' (''decimal'') - стоимость услуги на указанный период в EUR
пример запроса:
<nowiki>https://api-dev.acestream.net/?method=getServiceCost ↵
&api_version=1.0 ↵
&api_key=be6f66e0848528139583b567fb222215444fc8ac ↵
&app=9_50gh753t6uscog88800kcksw04s0o0wccscco8kgsogwkocwgw ↵
&service=noAds ↵
&period=m1 ↵
&sign=45c84ceffd3ec443586e8f4666b28abde8400768</nowiki>
ответ:
<nowiki>{"cost":1}</nowiki>
===activateService===
Активировать услугу для пользователя
параметры:
* '''app''' (''string'') - ключ приложения
* '''user_key''' (''string'') - ключ пользователя
* '''service''' (''string'') - идентификатор услуги
* '''period''' (''string'') - идентификатор периода
поля в ответе:
* '''validFrom''' (''unix timestamp'') - с какого времени услуга активна
* '''validTo''' (''unix timestamp'') - до какого времени услуга активна
пример запроса:
<nowiki>https://api-dev.acestream.net/?method=activateService ↵
&api_version=1.0 ↵
&api_key=be6f66e0848528139583b567fb222215444fc8ac ↵
&app=9_50gh753t6uscog88800kcksw04s0o0wccscco8kgsogwkocwgw ↵
&user_key=a455865e5800fd7efab75f2b4852fc2497f9fc39 ↵
&service=noAds ↵
&period=m1 ↵
&sign=c4df772a4a41ad7bbb4d7d07e46cad5e3622c59e</nowiki>
ответ (успешная активация услуги):
<nowiki>{"validFrom":1376048972,"validTo":1378640972}</nowiki>
ответ (недостаточно средств на балансе партнера):
<nowiki>{"error":"not enough credits"}</nowiki>
===getUserKeyInfo===
Получить информацию о ключе пользователя
параметры:
* '''app''' (''string'') - ключ приложения
* '''user_key''' (''string'') - ключ пользователя
поля в ответе:
* '''services''' (''array'') - массив услуг, привязанных к данному ключу пользователя. Каждая услуга описывается такими полями:
** '''id''' (''string'') - идентификатор услуги
** '''validFrom''' (''unix timestamp'') - с какого времени услуга активна
** '''validTo''' (''unix timestamp'') - до какого времени услуга активна
** '''enabled''' (''boolean'') - активна ли услуга в данный момент
пример запроса:
<nowiki>https://api-dev.acestream.net/?method=getUserKeyInfo ↵
&api_version=1.0 ↵
&api_key=be6f66e0848528139583b567fb222215444fc8ac ↵
&app=9_50gh753t6uscog88800kcksw04s0o0wccscco8kgsogwkocwgw ↵
&user_key=8fb311be3836b04f61817dbf8a23c05739ebb13e ↵
&sign=5e0fc46d908e5f224ce9fce9f6a83dd6b3502cc0</nowiki>
ответ (нет услуг):
<tt>{"services":[]}</tt>
ответ (есть услуги):
<nowiki>{"services": [
{"id": "noAds", "validFrom": 1374673235, "validTo": 1445089235, "enabled": true},
{"id": "premium", "validFrom": 1374858187, "validTo": 1448301787, "enabled": true}
]}</nowiki>
==Идентификаторы услуг==
* '''noAds''' - услуга "No ADs" (отключение рекламы Ace Stream)
* '''premium''' - услуга "Premium Streams" (доступ к премиум-контенту)
==Идентификаторы периодов==
* '''m1''' - 30 дней
* '''y1''' - 365 дней
Запросы API отправляются на адрес <tt><nowiki>https://api-dev.acestream.net</nowiki></tt> методом HTTP-GET.
Ответы на запросы приходят в формате json.
Если при обработке запроса возникла ошибка, будет отослан ответ такого вида:
<tt><nowiki>{"error":"error descrtiption"}</nowiki></tt>
Ответы за успешно обработанные запросы зависят от вызываемого метода.
===Обязательные общие параметры для всех запросов===
* '''method''' - вызываемый метод API
* '''api_key''' - ключ клиента API
* '''api_version''' - поддерживаемая версия API (текущая версия: 1.0)
* '''sign''' - цифровая подпись запроса
===Алгоритм формирования цифровой подписи===
* создается массив строк вида "название_параметра=значение_параметра"
* полученный массив сортируется
* элементы отсортированного массива объединяются в строку с разделителем "#"
* к полученной строке добавляется секретный ключ клиента API
* подписью является sha1-хеш от полученной строки (в шестнадцатеричном представлении, 40 символов, маленькими буквами)
Код на PHP:
<tt><nowiki>function makeSignature(array $params, $apiSecret)
{
$checkParams = array();
foreach($params as $k => $v) {
$checkParams[] = $k . '=' . $v;
}
sort($checkParams);
$payload = join('#', $checkParams);
$sign = sha1($payload . $apiSecret);
return $sign;
}</nowiki></tt>
==Методы API==
===getServiceCost===
Получить стоимость услуги
параметры:
* '''service''' (''string'') - идентификатор услуги
* '''period''' (''string'') - идентификатор периода
поля в ответе:
* '''cost''' (''decimal'') - стоимость услуги на указанный период в EUR
пример запроса:
<nowiki>https://api-dev.acestream.net/?method=getServiceCost ↵
&api_version=1.0 ↵
&api_key=be6f66e0848528139583b567fb222215444fc8ac ↵
&app=9_50gh753t6uscog88800kcksw04s0o0wccscco8kgsogwkocwgw ↵
&service=noAds ↵
&period=m1 ↵
&sign=45c84ceffd3ec443586e8f4666b28abde8400768</nowiki>
ответ:
<nowiki>{"cost":1}</nowiki>
===activateService===
Активировать услугу для пользователя
параметры:
* '''app''' (''string'') - ключ приложения
* '''user_key''' (''string'') - ключ пользователя
* '''service''' (''string'') - идентификатор услуги
* '''period''' (''string'') - идентификатор периода
поля в ответе:
* '''validFrom''' (''unix timestamp'') - с какого времени услуга активна
* '''validTo''' (''unix timestamp'') - до какого времени услуга активна
пример запроса:
<nowiki>https://api-dev.acestream.net/?method=activateService ↵
&api_version=1.0 ↵
&api_key=be6f66e0848528139583b567fb222215444fc8ac ↵
&app=9_50gh753t6uscog88800kcksw04s0o0wccscco8kgsogwkocwgw ↵
&user_key=a455865e5800fd7efab75f2b4852fc2497f9fc39 ↵
&service=noAds ↵
&period=m1 ↵
&sign=c4df772a4a41ad7bbb4d7d07e46cad5e3622c59e</nowiki>
ответ (успешная активация услуги):
<nowiki>{"validFrom":1376048972,"validTo":1378640972}</nowiki>
ответ (недостаточно средств на балансе партнера):
<nowiki>{"error":"not enough credits"}</nowiki>
===getUserKeyInfo===
Получить информацию о ключе пользователя
параметры:
* '''app''' (''string'') - ключ приложения
* '''user_key''' (''string'') - ключ пользователя
поля в ответе:
* '''services''' (''array'') - массив услуг, привязанных к данному ключу пользователя. Каждая услуга описывается такими полями:
** '''id''' (''string'') - идентификатор услуги
** '''validFrom''' (''unix timestamp'') - с какого времени услуга активна
** '''validTo''' (''unix timestamp'') - до какого времени услуга активна
** '''enabled''' (''boolean'') - активна ли услуга в данный момент
пример запроса:
<nowiki>https://api-dev.acestream.net/?method=getUserKeyInfo ↵
&api_version=1.0 ↵
&api_key=be6f66e0848528139583b567fb222215444fc8ac ↵
&app=9_50gh753t6uscog88800kcksw04s0o0wccscco8kgsogwkocwgw ↵
&user_key=8fb311be3836b04f61817dbf8a23c05739ebb13e ↵
&sign=5e0fc46d908e5f224ce9fce9f6a83dd6b3502cc0</nowiki>
ответ (нет услуг):
<tt>{"services":[]}</tt>
ответ (есть услуги):
<nowiki>{"services": [
{"id": "noAds", "validFrom": 1374673235, "validTo": 1445089235, "enabled": true},
{"id": "premium", "validFrom": 1374858187, "validTo": 1448301787, "enabled": true}
]}</nowiki>
==Идентификаторы услуг==
* '''noAds''' - услуга "No ADs" (отключение рекламы Ace Stream)
* '''premium''' - услуга "Premium Streams" (доступ к премиум-контенту)
==Идентификаторы периодов==
* '''m1''' - 30 дней
* '''y1''' - 365 дней