Основная информация flyLogin API v2
Используются HTTP ответы с кодом 200. Тело ответа обязательно содержит JSON-объект. Всегда присутствуют поля resultCode и resultMsg.
Пример ответа:
{"resultCode":200,"resultMsg":"OK"}
Возможные коды ответа (resultCode):
Код Описание
200 Функция выполнена успешно
400 Попытка вызова функции протоколом HTTP, а не HTTPS
401 Не верно указан APIKey
405 Попытка вызова функции методом отличным от GET
Поле resultMsg содержит детальную информацию об ошибке
Cписок зон
Точка входа: https://login.wifly.net/api/v2/<APIKey>/zones
Пример ответа:
Список гостей online
Точка входа: https://login.wifly.net/api/v2/<APIKey>/guests/online
Пример ответа:
Способ регистрации гостя:
:
| regMethod | regID | Описание |
|---|---|---|
| None | None |
Гость не был зарегистрирован (ни один из методов регистрации не включен на зоне) |
| SMS | Номер телефона | Гость зарегистрирован при помощи SMS |
| Call | Номер телефона | Гость зарегистрирован при помощи звонка на номер 8-800 |
| CallBack | Номер телефона | Гость зарегистрирован при помощи обратного звонка |
| Coupon | Номер комнаты |
Гость зарегистрирован при помощи купона |
Дата/время:
Дата и время предоставляются в формате ГГГГММДДччммсс.
Где:
ГГГГ — Порядковый номер года, 4 цифры.
ММ — Порядковый номер месяца с ведущим нулем.
ДД — День месяца, 2 цифры с ведущим нулем.
чч — Часы в 24-часовом формате с ведущим нулем.
мм — Минуты с ведущим нулем.
сс — Секунды с ведущим нулем.
Список сессий
Точка входа: https://login.wifly.net/api/v2/<APIKey>/sessions/<From>/<To>
Функция возвращает список завершенных сессий. Ниже описано использование параметров функции.
Точка входа: https://login.wifly.net/api/v2/<APIKey>/sessions
Функция без параметров возвращает список сессий за последние сутки.
Точка входа: https://login.wifly.net/api/v2/<APIKey>/sessions/<From>
Функция с одним параметром возвращает список сессий, с указанной даты/времени <From>.
Дата и время предоставляются в формате ГГГГММДДччммсс.
Коды в случае ошибки (resultCode):
| Код | Описание |
|---|---|
| 411 | Не верный формат даты/времени |
Точка входа: https://login.wifly.net/api/v2/<APIKey>/sessions/<From>/<To>
Функция с двумя параметрами возвращает список сессий, с даты/времени <From> по дату/время <To>.
Коды в случае ошибки (resultCode):
| Код | Описание |
|---|---|
| 411 | Не верный формат даты/времени <From> |
| 412 | Не верный формат даты/времени <To> |
| 413 |
Дата/время <From> позже даты/времени <To> |
Пример ответа:
Предполагаемый год рождения гостя:
В случае, если гость прошел опрос (указал количество полных лет), данное поле имеет значение предполагаемого года рождения.
Если гость указал свой возраст 60+, то данное поле будет иметь значение -1, если гость не прошел опрос, то это поле имеет значение 0.
Пол гостя:
В случае, если гость прошел опрос (указал свой пол), данное поле имеет значение male - мужской, или female - женский.
Если гость не прошел опрос, то это поле имеет значение unknown.