API
Инструмент для удаленного управления Личным кабинетом
- Описание API
Перед первым запросом активируйте API и задайте ключ в разделе "Профиль" Личного кабинета, иначе доступ с IP-адреса источника запроса будет заблокирован!
Удаленное взаимодействие с Аккаунтом и Устройствами происходит посредством GET запроса к текущему разделу сайта https://birevia.com/api. В ответ возвращается JSON-объект, либо ошибка. Каждый запрос должен содержать email (логин), apikey и одно действие action.
Пример запроса:https://birevia.com/api?email=your@mail.ru&apikey=yourApiKey&action=SameAction
Пример ответа:{ "result": "", "msg": "no action", "data": "" }
- getAccountInfo
- Данный метод позволяет получить информацию об Аккаунте.
Пример запроса:https://birevia.com/api?email=your@mail.ru&apikey=yourApiKey&action=getAccountInfo
Пример ответа:{ "result": true, "msg": "", "data": { "name": "", "status": "client", "balance": "0.00", "registerDate": "2017-03-05 15:38:48", "lastLoginDate": "2018-01-02 14:51:12", "partnerId": "bdebc8856e71dbc753a9864633af9353" } }
- getDeviceInfo
- Возвращает данные одного (id=12345678), нескольких (id=11111111,22222222) или всех (id=all) Устройств из Личного кабинета пользователя.
Пример запроса:https://birevia.com/api?email=your@mail.ru&apikey=yourApiKey&action=getDeviceInfo&id=12345678
Пример ответа:{ "result": true, "msg": "", "data": [{ "id": "12345678", "name": "Device Name", "tariffId": "9", "tariffName": "S", "uploadSpeed": "0.75", "uploadSpeedUnit": "Mbit\/s", "traffic": "unlimited", "uploadSpeedPrice": "55.50", "status": "wait", "autoProlong": false, "prolongOneTime": false, "notices": true, "expirationDate": "2018-01-31 09:55:01", "protocol": "L2TP\/IPSEC", "staticIp": "185.200.0.200", "portStart": "10200", "portEnd": "10299", "serverName": "nika.birevia.com", "remoteIp": "172.17.1.2", "localIp": "172.17.1.4", "password": "password", "psk": "preshared_secret_key" }] }
- getTariffs
- Возвращает данные всех действующих тарифов.
Пример запроса:https://birevia.com/api?email=your@mail.ru&apikey=yourApiKey&action=getTariffs
Пример ответа:{ "result": true, "msg": "", "data": [{ "id": "1", "type": "traffic", "name": "XS", "traffic": "104857600", "price": "29.95" }, { "id": "9", "type": "speed", "name": "S", "speed": "0.75", "price": "55.50" }, { "id": "7", "type": "speed", "name": "L", "speed": "3.00", "price": "149.50" }, { "id": "8", "type": "speed", "name": "XL", "speed": "6.00", "price": "247.00" }] }
- addNewDevice
- Метод создает новое Устройство в Личном кабинете и возвращает его ID или FALSE если Устройство без тарифа уже существует. Без тарифа может быть только одно Устройство.
Пример запроса:https://birevia.com/api?email=your@mail.ru&apikey=yourApiKey&action=addNewDevice
Пример ответа:{ "result": true, "msg": "", "data": { "id": 12345678 } }
- deleteDevice
- Метод удаляет Устройство из Личного кабинета и возвращает текущий Баланс, если сумма возврата больше 0.
Пример запроса:https://birevia.com/api?email=your@mail.ru&apikey=yourApiKey&action=deleteDevice&id=12345678
Пример ответа:{ "result": true, "msg": "", "data": { "balance": 29.95 } }
- addTariff
- Метод добавляет тариф на предвариательно созданное Устройство и возвращает текущий Баланс.
Пример запроса:https://birevia.com/api?email=your@mail.ru&apikey=yourApiKey&action=addTariff&id=12345678&tariffId=6
Пример ответа:{ "result": true, "msg": "", "data": { "balance": 29.95 } }
- addFreeTariff
- Метод добавляет бесплатный тариф для тестирования на предвариательно созданное Устройство.
Пример запроса:https://birevia.com/api?email=your@mail.ru&apikey=yourApiKey&action=addFreeTariff&id=12345678
Пример ответа:{ "result": true, "msg": "", "data": "" }
- changeTariff
- Метод заменяет текущий тариф на Устройстве на указанный в tariffId. Возвращает JSON-объект либо FALSE в случае ошибки. Нельзя заменить тариф на аналогичный, либо если срок действия тарифа истек, либо если тариф бесплатный.
Пример запроса:https://birevia.com/api?email=your@mail.ru&apikey=yourApiKey&action=changeTariff&id=12345678&tariffId=6
Пример ответа:{ "result": true, "msg": "", "data": "" }
- changeProtocol
- Метод заменяет текущий протокол авторизации Устройства на указанный в protocol (PPTP, L2TP, L2TP/IPSEC). Возвращает JSON-объект либо FALSE в случае ошибки.
Пример запроса:https://birevia.com/api?email=your@mail.ru&apikey=yourApiKey&action=changeProtocol&id=12345678&protocol=L2TP
Пример ответа:{ "result": true, "msg": "", "data": "" }
- changeOption
- Метод включает (state=1) или выключает (state=0) опции type (prolong, prolong1t, notice) на Устройстве. Возвращает JSON-объект.
Пример запроса:https://birevia.com/api?email=your@mail.ru&apikey=yourApiKey&action=changeOption&id=12345678&type=notice&state=0
Пример ответа:{ "result": true, "msg": "", "data": "" }