==Общее описание Common description of API==Данное This API позволяет работать с [[User_key|ключами пользователей]] в системе allows you to work with user keys in Ace Streamsystem. API предоставляет методы для создания ключей пользователей и для активации различных опций для ключейprovides methods to create user keys and activate different options for the keys.
Работать с данным ==Requests format==API могут [[Resellers|реселлеры]] либо [[Developers|разработчики приложений]]requests are sent via HTTP-GET method to the following addresses:* test mode: <tt><nowiki>https://api-sandbox.acestream.net/reseller</nowiki></tt>* work mode: <tt><nowiki>https://api.acestream.net/reseller</nowiki></tt>
==Формат запросов==Запросы API отправляются методом HTTP-GET на такие адреса:* тестовый режим: <tt><nowiki>https://api-sandboxResponses for these requests comes in json format.acestream.net/reseller</nowiki></tt>* боевой режим: <tt><nowiki>https://api.acestream.net/reseller</nowiki></tt>
Ответы на запросы приходят в формате json. Если при обработке запроса возникла ошибкаIf during query processing an error was occurred, будет отослан ответ такого видаthe following kind of response will be sent:
<tt><nowiki>{"error":"error descrtiption"}</nowiki></tt>
Ответы за успешно обработанные запросы зависят от вызываемого метода. ===Обязательные общие параметры для всех запросов===* '''Responses to successfully processed requests depend on a method''' - вызываемый метод API* '''api_key''' - ключ клиента API* '''api_version''' - поддерживаемая версия API (текущая версия: 1.0)* '''sign''' - цифровая подпись запросаbeing called
В зависимости от того, кто обращается к ===Required common parameters for all requests===* '''method''' - called API method* '''api_key''' - API client key* '''api_version''' - supported API version (разработчик или реселлерcurrent version: 1.0), должен присутствовать один из параметров:* '''app''' - идентификатор маркета (для [[Resellers|реселлеров]])market ID* '''productsign''' - публичная часть [[Product_key|ключа продукта]] (для [[Developers|разработчиков приложений]])request's digital signature
===Алгоритм формирования цифровой подписиAlgorithm for generating a digital signature===* создается массив строк вида array of strings like "название_параметраparameter_name=значение_параметраparameter_value"is created* полученный массив сортируетсяthe resulting array is sorted* элементы отсортированного массива объединяются в строку с разделителем elements of the sorted array are combined in a string with a separator "#"* к полученной строке добавляется секретный ключ клиента private key of APIclient is added to the resulting string* подписью является signature is sha1-хеш от полученной строки hash of the resulting string (в шестнадцатеричном представленииin hexadecimal representation, 40 символовcharacters, маленькими буквамиlowercase)
Код на PHPcode:
<tt><nowiki>function makeSignature(array $params, $apiSecret)
{
}</nowiki></tt>
==Методы APImethods==
===getServiceCost===
Получить стоимость опцииGet the cost of a service
параметрыparameters:* '''service''' (''string'') - идентификатор опцииservice ID* '''period''' (''string'') - идентификатор периодаperiod ID
поля в ответеfields in response:* '''cost''' (''decimal'') - стоимость опции на указанный период в the cost of the service for a specified period in EUR
пример запросаrequest example:
<nowiki>https://api.acestream.net/reseller?method=getServiceCost ↵
&api_version=1.0 ↵
&sign=45c84ceffd3ec443586e8f4666b28abde8400768</nowiki>
ответresponse:
<nowiki>{"cost":1}</nowiki>
===activateService===
Активировать опцию для пользователя.Activate service for user
В результате успешной активации средства будут списаны с баланса реселлераAs a result of successful activation, funds will be charged from reseller's balance.
параметрыparameters:* '''user_key''' (''string'') - ключ пользователяuser key* '''service''' (''string'') - идентификатор опцииservice ID* '''period''' (''string'') - идентификатор периодаperiod ID
поля в ответеfields in response:* '''validFrom''' (''unix timestamp'') - с какого времени опция активнаfrom what time service is active* '''validTo''' (''unix timestamp'') - до какого времени опция активнаtill what time service will be active
пример запросаrequest example:
<nowiki>https://api.acestream.net/reseller?method=activateService ↵
&api_version=1.0 ↵
&sign=c4df772a4a41ad7bbb4d7d07e46cad5e3622c59e</nowiki>
ответ response (успешная активация опцииsuccessful activation):
<nowiki>{"validFrom":1376048972,"validTo":1378640972}</nowiki>
ответ response (на балансе реселлера недостаточно средств для активации опцииthere are not enough funds on resellers balance to activate the service):
<nowiki>{"error":"not enough credits"}</nowiki>
===getUserKeyInfo===
Получить информацию о ключе пользователяGet information about user key
параметрыparameters:* '''user_key''' (''string'') - ключ пользователяuser key
поля в ответеfields in response:* '''services''' (''array'') - массив опцийarray of services, привязанных к данному ключу пользователяbound to this user key. Каждая опция описывается такими полямиEach service ia described with the following fields:** '''id''' (''string'') - идентификатор опцииservice ID** '''validFrom''' (''unix timestamp'') - с какого времени опция активнаfrom what time service is active** '''validTo''' (''unix timestamp'') - до какого времени опция активнаtill what time service will be active** '''enabled''' (''boolean'') - активна ли опция в данный моментis service active at this moment
пример запросаrequest example:
<nowiki>https://api.acestream.net/reseller?method=getUserKeyInfo ↵
&api_version=1.0 ↵
&sign=5e0fc46d908e5f224ce9fce9f6a83dd6b3502cc0</nowiki>
ответ response (нет опцийno services):
<tt>{"services":[]}</tt>
ответ response (есть опцииthere are services):
<nowiki>{"services": [
{"id": "noAds", "validFrom": 1374673235, "validTo": 1445089235, "enabled": true},
===createUserKey===
Создать новый ключ пользователя Если ключ пользователя создается от имени разработчика приложений, то его действие распостраняется только на продукт данного разработчика, указанный в параметре <tt>product</tt>. Если ключ пользователя создается от имени реселлера, то его действие распостраняется на любые продукты. Create a new user key
поля в ответеfields in response:* '''userKey''' (''string'') - созданный ключ пользователяcreated user key* '''extension''' (''string'') - содержимое файла-расширения, который используется для последующей загрузки в движокcontent of extension file which is used for the following loading to the engine
пример запросаrequest example:
<nowiki>https://api.acestream.net/reseller?method=createUserKey ↵
&sign=99982a11708ef4a80e12f1ca845d314340db8869</nowiki>
ответresponse:
<tt>{
"userKey": "c7456d962209ce22a8edd0c788940a15792bc575",
}</tt>
==Идентификаторы опцийService ID==* '''noAds''' - опция service "No ADs" (отключение рекламы disable Ace Streamads)* '''premium''' - опция service "Premium Streams" (доступ к премиумaccess to premium content)* '''premium1device''' - premium for one device* '''proxyServer''' - "Proxy Server" option (it allows using Ace Stream by third-контентуparty software products)
==Идентификаторы периодовPeriod ID==* '''m1''' - 30 днейdays* '''y1''' - 365 днейdays
