Описание методов API для использования разработчиками в сторонних приложениях
API для разработчиков
Мы предоставляем API нашего сайта для разработчиков приложений. Доступ до API осуществляется по ключу, который вы можете получить написав нам. В письме кратко опишите для каких целей вам нужен доступ к API.
Описание методов
Ко всем запросам НУЖНО добавлять get параметр key со значением ключа доступа. Пример:
Для запросов, которые возвращают более одного объекта, возможно задать следующие необязательные параметры:
/api/1.0/categories?key=abc123Для запросов, которые возвращают более одного объекта, возможно задать следующие необязательные параметры:
sort_field - имя поля, по которому будет отсортирован результат (по умолчанию - id)
sort_dir - направление сортировки (asc - по возростанию/desc - убыванию) (по умолчанию - asc)
take - предназначен для ограничения количества результатов (числовое значение)
offset - предназначен для пропуска заданного количества результатов (числовое значение)
sort_dir - направление сортировки (asc - по возростанию/desc - убыванию) (по умолчанию - asc)
take - предназначен для ограничения количества результатов (числовое значение)
offset - предназначен для пропуска заданного количества результатов (числовое значение)
# Рубрики
Список всех рубрик
GET
/api/1.0/categoriesПример ответа
Content-Type: application/json
[{
"id":1,
"title":"Эскейп-квесты",
"middle_image":"https://funtime.kiev.ua/uploads/img/escape-quests-553e3d5f7e992.jpg"
},
{
"id":6,
"title":"Куда поехать",
"middle_image":"https://funtime.kiev.ua/uploads/img/where-to-go-55433ebc1e65c.jpg"
}]Рубрика
GET
/api/1.0/categories/{category_id}Параметры
category_id - целочисельный идентификатор рубрикиПример ответа
Content-Type: application/json
[{
"id":1,
"title":"Эскейп-квесты",
"description":"<p>Разве есть что-то не по силам супергероям современности “ты ж программист\"-ам? Разумеется - нет. И кран починят, и винду поставят, и лампочку вкрутят, и в перерывах между каждодневными подвигами придумают новое интерактивное развлечение \"real-life room escape games\". Озадачены? Впервые слышите?) Возможно, так привычней - “квест - комната\". Не помогло? “Эскейп рум\" (“эскейп комната\"), “escape quest\" (“эскейп квест\"), “квест в реальности\"... Все названия и не перечислить, как хотят - так и называют.</p><p>Что же скрывается под всеми этими названиями?</p>",
"middle_image":"https://funtime.kiev.ua/uploads/img/escape-quests-f7e992.jpg"
}]# Типы
Список всех типов
GET
/api/1.0/typesПример ответа
Content-Type: application/json
[{
"id":1,
"title":"Квест-комната",
"title_plural":"Квест-комнаты"
},
{
"id":2,
"title":"Квест-пространство",
"title_plural":"Квест-пространства"
}]Список типов отдельной рубрики
GET
/api/1.0/categories/{category_id}/typesПараметры
category_id - целочисельный идентификатор рубрикиПример ответа
Content-Type: application/json
[{
"id":1,
"title":"Квест-комната",
"title_plural":"Квест-комнаты"
},
{
"id":2,
"title":"Квест-пространство",
"title_plural":"Квест-пространства"
},
{
"id":4,
"title":"Сеть квест комнат",
"title_plural":"Сети квест комнат"
},
{
"id":6,
"title":"Массовый квест",
"title_plural":"Массовые квесты"
}]Тип
GET
/api/1.0/types/{type_id}Параметры
type_id - целочисельный идентификатор типаПример ответа
Content-Type: application/json
[{
"id":1,
"title":"Квест-комната",
"title_plural":"Квест-комнаты"
}]# Объекты (локации)
Список всех объектов
GET
/api/1.0/locationsПример ответа
Content-Type: application/json
[{
"id":4,
"title":"Escape Quest на Почайнинской",
"expert_rating":4.1,
"user_rating":0,
"review_count":0,
"published_at":"2015-04-03 08:08:16",
"middle_image":"https://funtime.kiev.ua/uploads/img/e8caa5.jpg",
"small_image":"https://funtime.kiev.ua/uploads/img/56cda5.jpg"
},
{
"id":5,
"title":"Заброшенный бункер",
"expert_rating":4.1,
"user_rating":3,
"review_count":6,
"published_at":"2015-04-03 21:10:15",
"middle_image":"https://funtime.kiev.ua/uploads/img/3e6e4deec1.jpg",
"small_image":"https://funtime.kiev.ua/uploads/img/33e6e4deec1.jpg"
}]Список объектов отдельной рубрики
GET
/api/1.0/categories/{category_id}/locationsПараметры
category_id - целочисельный идентификатор рубрикиПример ответа
Content-Type: application/json
[{
"id":4,
"title":"Escape Quest на Почайнинской",
"expert_rating":4.1,
"user_rating":0,
"review_count":0,
"published_at":"2015-04-03 08:08:16",
"middle_image":"https://funtime.kiev.ua/uploads/img/e8caa5.jpg",
"small_image":"https://funtime.kiev.ua/uploads/img/56cda5.jpg"
},
{
"id":5,
"title":"Заброшенный бункер",
"expert_rating":4.1,
"user_rating":3,
"review_count":6,
"published_at":"2015-04-03 21:10:15",
"middle_image":"https://funtime.kiev.ua/uploads/img/3e6e4deec1.jpg",
"small_image":"https://funtime.kiev.ua/uploads/img/33e6e4deec1.jpg"
}]Список объектов отдельного типа
GET
/api/1.0/types/{type_id}/locationsПараметры
type_id - целочисельный идентификатор типаПример ответа
Content-Type: application/json
[{
"id":5,
"title":"Заброшенный бункер",
"expert_rating":4.1,
"user_rating":3,
"review_count":6,
"published_at":"2015-04-03 00:00:00",
"middle_image":"https://funtime.kiev.ua/uploads/img/e4deec1.jpg",
"small_image":"https://funtime.kiev.ua/uploads/img/6e4deec1.jpg"
},
{
"id":6,
"title":"Кабинет КГБ",
"expert_rating":3.8,
"user_rating":3.9,
"review_count":9,
"published_at":"2015-01-01 00:00:00",
"middle_image":"https://funtime.kiev.ua/uploads/img/a527.jpg",
"small_image":"https://funtime.kiev.ua/uploads/img/9275a527.jpg"
}]Объект
GET
/api/1.0/locations/{location_id}Параметры
location_id - целочисельный идентификатор объектаПример ответа
Content-Type: application/json
[{
"id":111,
"title":"Побег из тюрьмы",
"expert_rating":0,
"user_rating":4.2,
"review_count":2,
"published_at":"2015-06-24 00:00:00",
"visited_count":6,
"planning_count":2,
"longitude":30.4731,
"latitude":50.4648,
"address":"Киев, ул. Белорусская 34",
"main_text":"<p>Вы проснулись от ужасной головной боли. Вам показалась, будто кто-то одел вам на голову металлический таз и упрямо бил по нему палкой. Ваша голова просто раскалывалась и ныла. Тяжелые веки еле-еле раскрылись, и вы с трудом осмотрелись вокруг...</p>",
"website":"escapequest.com.ua",
"phone":"0939191513",
"phone_1":"0445801310",
"phone_2":"",
"phone_3":"",
"phone_4":"",
"vkontakte":"escapequest",
"facebook":"escapequest",
"twitter":"escapequestua",
"gplus":"",
"instagram":"escapequest",
"foursquare":"escapequestua",
"tripadvisor":"Attraction_Review-g294474-d6985192-Reviews-Escape_Quest-Kiev.html",
"youtube":"",
"vimeo":"",
"type_title":"Квест-пространство",
"middle_image":"https://funtime.kiev.ua/uploads/img/18b568.jpg",
"small_image":"https://funtime.kiev.ua/uploads/img/a69418b568.jpg",
"big_image":"https://funtime.kiev.ua/uploads/img/69418b568.jpg",
"images_gallery":
[{
"small_image":"https://funtime.kiev.ua/uploads/img/694419029.jpg",
"big_image":"https://funtime.kiev.ua/uploads/img/a694419029.jpg"
}]
}]