Описание API версии 2 сайта lovushka-quest.ru

Изменения во второй версии API

1. Изменение адреса в запросе - api поменялся на apiv2.

2. При получении расписания изменился возвращаемый JSON (п. 5).

3. Добавлена возможность получения расписания на две недели вперед (п. 6).

4. При бронировании квеста изменились ожидаемые поля и возвращаемый JSON (п. 7).

Описание API

1. Получение городов

Для получения списка городов необходимо отправить GET запрос на адрес http://lovushka-quest.ru/api/cities

Ожидаемые поля:

• login: Логин для доступа к API, выдается администратором сайта
• secret: Секретное слово для доступа к API, выдается администратором сайта

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

# GET http://lovushka-quest.ru/apiv2/cities?login=test_login&secret=secret_word455

Возвращаемый JSON:

{

"status":"success",

"response":

[

{

"id":"1",

"name":"Москва"

},

{

"id":"2",

"name":"Санкт-Петербург"

}

]

}

Где:

• id - id города
• name - название города

Для получения id конкретного города необходимо отправить GET запрос на адрес http://lovushka-quest.ru/apiv2/city

Ожидаемые поля:

• login: Логин для доступа к API, выдается администратором сайта
• secret: Секретное слово для доступа к API, выдается администратором сайта
• name: Название города, по которому будет осуществляться поиск

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

# GET http://lovushka-quest.ru/apiv2/cities?name=Москва&login=test_login&secret=secret_word455

Возвращаемый JSON:

{

"status":"success",

"response":

{

"id":"1",

"name":"Москва"

}

}

Где:

• id - id города
• name - название города

Для получения id всех квестов необходимо отправить GET запрос на адрес http://lovushka-quest.ru/apiv2/quests

Ожидаемые поля:

• login: Логин для доступа к API, выдается администратором сайта
• secret: Секретное слово для доступа к API, выдается администратором сайта
• city: ID города, по которому будет осуществляться поиск

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

# GET http://lovushka-quest.ru/apiv2/quests?city=26&login=test_login&secret=secret_word455

Возвращаемый JSON:

{

"status":"success",

"response":

[

{

"id":"138",

"name":"Виртуальный квест: Интерстеллар",

"time":"3600 секунд",

"address":"Екатеринбург, Металлургов, 84",

"phone":"+7 (950) 644-62-08",

"min_age":"0",

"min_players":"2",

"max_players":"4"

}

]

}

Где:

• id - id квеста
• name - название квеста
• time - время прохождения
• address - адрес расположения квеста
• phone - телефон администрации квеста
• min_age - возрастные ограничения
• min_players - минимальное число игроков
• max_players - максимальное число игроков

Для получения квеста по его ID необходимо отправить GET запрос на адрес http://lovushka-quest.ru/apiv2/quest

Ожидаемые поля:

• login: Логин для доступа к API, выдается администратором сайта
• secret: Секретное слово для доступа к API, выдается администратором сайта
• quest: ID квеста, по которому будет осуществляться поиск

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

# GET http://lovushka-quest.ru/apiv2/quest?quest=138&login=test_login&secret=secret_word455

Возвращаемый JSON:

{

"status":"success",

"response":

{

"id":"138",

"name":"Виртуальный квест: Интерстеллар",

"time":"3600 секунд",

"address":"Екатеринбург, Металлургов, 84",

"phone":"+7 (950) 644-62-08",

"min_age":"0",

"min_players":"2",

"max_players":"4"

}

}

Где:

• id - id квеста
• name - название квеста
• time - время прохождения
• address - адрес расположения квеста
• phone - телефон администрации квеста
• min_age - возрастные ограничения
• min_players - минимальное число игроков
• max_players - максимальное число игроков

Для получения расписания квеста необходимо отправить GET запрос на адрес http://lovushka-quest.ru/apiv2/schedule

Ожидаемые поля:

• login: Логин для доступа к API, выдается администратором сайта
• secret: Секретное слово для доступа к API, выдается администратором сайта
• quest: ID квеста, по которому будет осуществляться поиск
• date: Дата в формате YYYY-MM-DD

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

# GET http://lovushka-quest.ru/apiv2/schedule?quest=138&date=2016-06-30&login=test_login&secret=secret_word455

Возвращаемый JSON:

{

"status":"success",

"response":

[

{

"date":"2016-07-21",

"time":"10:00",

"is_free":false,

"price":2000

},

{

"date":"2016-07-21",

"time":"11:15",

"is_free":false,

"price":2000

},

{

"date":"2016-07-21",

"time":"12:30",

"is_free":true,

"price":2000

}

]

}

Где:

• price - стоимость посещения
• time - время начала квеста
• date - дата начала квеста
• is_free - статус квеста (true - свободен, false - время занято)

Для получения расписания квеста на две недели вперед, начиная от текучей даты, необходимо отправить GET запрос на адрес http://lovushka-quest.ru/apiv2/schedule/two_weeks

Ожидаемые поля:

• login: Логин для доступа к API, выдается администратором сайта
• secret: Секретное слово для доступа к API, выдается администратором сайта
• quest: ID квеста, по которому будет осуществляться поиск

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

# GET http://lovushka-quest.ru/apiv2/schedule/two_weeks?quest=138&login=test_login&secret=secret_word455

Возвращаемый JSON:

{

"status":"success",

"response":

[

[

{

"date":"2016-07-21",

"time":"10:00",

"is_free":false,

"price":2000

},

{

"date":"2016-07-21",

"time":"11:15",

"is_free":false,

"price":2000

},

{

"date":"2016-07-21",

"time":"12:30",

"is_free":true,

"price":2000

}

],

[

{

"date":"2016-07-22",

"time":"10:00",

"is_free":true,

"price":2000

},

{

"date":"2016-07-22",

"time":"11:15",

"is_free":true,

"price":2000

},

{

"date":"2016-07-22",

"time":"12:30",

"is_free":true,

"price":2000

}

]

]

}

Где:

• price - стоимость посещения
• time - время начала квеста
• date - дата начала квеста
• is_free - статус квеста (true - свободен, false - время занято)

Для бронирования квеста необходимо отправить GET запрос на адрес http://lovushka-quest.ru/apiv2/add

Ожидаемые поля:

• login: Логин для доступа к API, выдается администратором сайта
• secret: Секретное слово для доступа к API, выдается администратором сайта
• quest_id: ID квеста
• date: Дата в формате YYYY-MM-DD
• time: Время начала квеста в формате HH:MM
• name: Имя пользователя, бронирующего квест
• price: Стоимость квеста
• lastname: Фамилия пользователя
• comment: Комментарий пользователя
• phone: Телефон пользователя в виде: 89814443322, 8-981-444-33-22, +79814443322 (Пропускаются только цифры, "+" и "-")

Все поля обязательные, кроме lastname и comment

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

# GET http://lovushka-quest.ru/apiv2/add?quest_id=138&date=2016-06-30&time=22:30&name=Иван&lastname=Петров&phone=89212223344&price=4700&login=test_login&secret=secret_word455

Возвращаемый JSON:

{

"status":"success",

"response":

{

"id":"4700",

"sum":"4700",

}

}

Где:

• id - номер брони

Для получения списка броней пользователя необходимо отправить GET запрос на адрес http://lovushka-quest.ru/apiv2/list

Ожидаемые поля:

• login: Логин для доступа к API, выдается администратором сайта
• secret: Секретное слово для доступа к API, выдается администратором сайта
• email: Адрес электронной почты пользователя

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

# GET http://lovushka-quest.ru/apiv2/[email protected]&login=test_login&secret=secret_word455

Возвращаемый JSON:

{

"status":"success",

"response":

{

"active":

[

{

"id":"17400",

"quest":"138",

"sum":"2500",

"date":"30-06-2016"

"time":"21:15"

},

{

"id":"17402",

"quest":"138",

"sum":"2500",

"date":"30-06-2016"

"time":"20:00"

}

],

"done":

[

{

"id":"17392",

"quest":"138",

"sum":"2500",

"date":"30-06-2016"

"time":"10:00"

}

]

}

}

Где:

• active - активные заказы
• done - завершенные
• id - номер брони
• quest - ID квеста
• sum - сумма к оплате
• date - дата прохождения квеста
• time - время прохождения квеста

Для получения брони пользователя необходимо отправить GET запрос на адрес http://lovushka-quest.ru/apiv2/get

Ожидаемые поля:

• login: Логин для доступа к API, выдается администратором сайта
• secret: Секретное слово для доступа к API, выдается администратором сайта
• email: Адрес электронной почты пользователя
• number: Номер брони

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

# GET http://lovushka-quest.ru/apiv2/[email protected]&login=test_login&secret=secret_word455

Возвращаемый JSON:

{

"status":"success",

"response":

{

"id":"17400",

"quest":"138",

"sum":"2500",

"date":"30-06-2016"

"time":"21:15"

}

}

Где:

• id - номер брони
• quest - ID квеста
• sum - сумма к оплате
• date - дата прохождения квеста
• time - время прохождения квеста

Для отмены брони необходимо отправить GET запрос на адрес http://lovushka-quest.ru/apiv2/cancel

Ожидаемые поля:

• login: Логин для доступа к API, выдается администратором сайта
• secret: Секретное слово для доступа к API, выдается администратором сайта
• email: Адрес электронной почты пользователя
• number: Номер брони
• cause: Причина отмена брони

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

# GET http://lovushka-quest.ru/apiv2/[email protected]&cause=test&login=test_login&secret=secret_word455

Возвращаемый JSON:

{

"status":"success"

}

Для отмены брони по номеру телефона необходимо отправить GET запрос на адрес http://lovushka-quest.ru/apiv2/delete

Ожидаемые поля:

• login: Логин для доступа к API, выдается администратором сайта
• secret: Секретное слово для доступа к API, выдается администратором сайта
• phone: Телефон пользователя
• number: Номер брони
• cause: Причина отмена брони

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

# GET http://lovushka-quest.ru/apiv2/delete?number=14700&phone=79814443322&cause=test&login=test_login&secret=secret_word455

Возвращаемый JSON:

{

"status":"success"

}