Генерация ваучера

Если вы используете автоматизированную систему управления отелем, такую как Fidelio, Opera, 1C, вы можете настроить её на взаимодействие с нашим сервисом. Например, при заселении гостя в момент, когда вы вносите его персональные данные, вы можете отправить запрос на генерацию ваучера. В запросе вы указываете требуемые параметры, например, скорость доступа и время действия ваучера, и в ответ получаете пару логин/пароль, которые можно распечатать и передать гостю. Также, если пожелаете хранить персональные данные о пользователях в нашей системе, можно передать их с помощью необязательных параметров.

Для того, чтобы сгенерировать ваучер, необходимо отправить GET или POST запрос на наш сервер https://api.wifisystem.ru/api , указав при этом ряд параметров.

Параметр Описание Тип
act нужно передать значение create_voucher обязателный
key API ключ, находится в личном кабинете в «Профиле пользователя» обязательный
voucher_type Тип ваучера. Возможные значения: 1 — учёт по времени, 2 — учёт по трафику обязательный
amount Номинал ваучера, период в часах или объем в мегабайтах. Задается в зависимости от выбранного типа обязательный
speed Скорость доступа к сети Интернет, в мбит/сек. 0 — скорость неограничена обязательный
expire Срок в течение которого ваучер остается годным , после первой активации, в днях обязательный
data Персональные данные о пользователе. ФИО, дата рождения, место рождения и т.п. необязательный

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

http://api.wifisystem.ru/api.xml?act=create_voucher&key=9a9b42a034562a4954a9a30d6b221b&voucher_type=1&amount=72&speed=3&expire=7&data=Иванов%20Сергей%20Викторович

Данный пример генерирует ваучер с типом по времени, суммарным временем на 72 часа, со скоростью доступа 3 мбит/с , и который истечет через 7 дней после первой активации.

Ответ вы можете получать в формате текста, json или xml форматов.

http://api.wifisystem.ru/api?параметры…
http://api.wifisystem.ru/api.json?параметры…
http://api.wifisystem.ru/api.xml?параметры…

Ответ содержит в себе статус запроса, и пару логин/пароль  для доступа ваших посетителей.

Параметр Описание статуса
result Код ответа
resulttxt Текстовая расшифровка кода
username Логин
password Пароль

Пример ответа

формат xml

<voucher>
<result>0</result>
<resulttxt>OK</resulttxt>
<username>zs3x8rf7</username>
<password>6128</password>
</voucher>

Статусы могут принимать следующие значения:

Код статуса,  result Описание статуса, resulttxt
0 ОК
1 Несуществующий API key
2 Несуществующий тип ваучера
3 Отсутствуют обязательные параметры
5 Превышен разрешенный суточный лимит по созданию ваучеров
7 Генерация ваучеров запрещена
8 Недостаточно денег на балансе
9 Значение слишком мало
10 Значение слишком велико

Изменение ваучера

Для того, чтобы сгенерировать ваучер, необходимо отправить GET или POST запрос на наш сервер https://api.wifisystem.ru/api , указав при этом ряд параметров.

Параметр Описание Тип
act нужно передать значение update_voucher обязателный
key API ключ, находится в личном кабинете в «Профиле пользователя» обязательный
username Логин ваучера обязательный
amount Номинал ваучера, период в часах или объем в мегабайтах. Задается в зависимости от выбранного типа обязательный
speed Скорость доступа к сети Интернет, в мбит/сек. 0 — скорость неограничена обязательный
expire Срок в течение которого ваучер остается годным , после первой активации, в днях обязательный
data Персональные данные о пользователе. ФИО, дата рождения, место рождения и т.п. необязательный

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

http://api.wifisystem.ru/api.xml?act=update_voucher&key=9a9b42a034562a4954a9a30d6b221b&username=asx7pk29x&amount=72&speed=3&expire=7&data=Иванов%20Сергей%20Викторович

 

Получение номера телефона и MAC-адреса после авторизации

api-params

В момент завершения процесса авторизации, данные о посетители могут быть переданы в вашу информационную систему.

Для получения  данных об авторизованных пользователях, Вы можете использовать специальные теги в параметрах.

Тег Описание Тип
{phone} Номер телефона посетителя необязательный
{mac} MAC-адрес устройства посетителя необязательный
{signature} Служит для проверки присылаемых параметров. Формируется как md5(phone+mac+API ключ). API ключ, находится в личном кабинете в «Профиле пользователя» необязательный
{nasid} Идентификатор хотспота на котором произошла авторизация необязательный

Теги задаются при настройки хотспота в личном кабинете в поле «Ссылка для перенаправления пользователя«, например так:

http://your-site.ru/?phone={phone}&mac={mac}&signature={signature}&nasid={nasid}

URL обязательно должен начинаться с http, использовать https нельзя.

Управление Хотспотом.

Можно блокировать, разблокировать и узнать статус хотспота.

Тег Описание Тип
{key} API ключ, находится в личном кабинете в «Профиле пользователя» обязательный
{nasid} Идентификатор хотспота(NAS ID) обязательный
{uamsecret} Пароль (UAM Secret) обязательный

Блокировка хотспота

https://lk.wifisystem.ru/api?act=block_hotspot&key={key}&nasid={nasid}&uamsecret={uamsecret}

Разблокировка хотспота

https://lk.wifisystem.ru/api?act=unlock_hotspot&key={key}&nasid={nasid}&uamsecret={uamsecret}

Получение Статуса хотспота

https://lk.wifisystem.ru/api?act=get_hotspot_status&key={key}&nasid={nasid}&uamsecret={uamsecret}

Возвращаемые статусы

Параметр,  result Описание статуса, resulttxt
501 Хотспот в состоянии — разблокирован
502 Хотспот в состоянии — заблокирован
503 Хотспот разблокирован
504 Хотспот заблокирован
505 Хотспот уже разблокирован
506 Хотспот уже заблокирован

Получение Баланса

Запрос баланса лицевого счёта:

https://lk.wifisystem.ru/api?act=get_balance&key={key}

Тег Описание Тип
{key} API ключ, находится в личном кабинете в «Профиле пользователя» обязательный

Поулчаемый ответ:

Параметр Описание
balance Баланс лицевого счёта