Спецификация API v2024

Доступные локации

Поднебесный — это величественный мегаполис, где гармонично переплелись древние традиции и передовые технологии, создавая уникальный симбиоз науки и магии. Расположенный на вершинах парящих гор, город кажется парящим в небесах, окруженный облаками и пронизанный сиянием таинственных энергий.
Архитектура Поднебесного — это великолепное сочетание старинных храмов и футуристических небоскребов. Узкие улочки с вымощенными камнями ведут к дворцам и пьяццам, где высоченные башни из стекла и стали украшают древние драконы, витыми узорами которых пронизывают руны, светящиеся мягким светом. Эти руны питаются магической энергией, создавая защитные барьеры и источники света, а также управляющие системы города.
Жители Поднебесного — это мастера древних искусств и современные ученые, которые совместно создают удивительные вещи. В университетах города изучают как программирование, так и заклинания; ученики обучаются мастерству владения как мечом, так и пультом управления дронами. Здесь на улицах можно увидеть магов, заключающих энергию в кристаллы, которые затем используются для питания техники, а также инженеров, создающих устройства, способные управлять погодой или лечить раны.
Поднебесный — это место, где будущее и прошлое, технологии и магия, сливаются воедино, создавая неповторимую атмосферу и жизнь в мире, который кажется одновременно древним и невероятно продвинутым.

Сайты

Название	<site>
Поднебесный	`celestial`

Получить места

Возвращает перечень мест с их идентификатором, описанием, категорией и координатами.

Адрес API

GET /api/v2024/<site>/get_locations/

Параметры

Параметр	Тип	Описание
`site`	string	Название сайта на латинице

Ответ

JSON-объект со следующей структурой:

{"count": Количество локаций (int)
 "locations": [
        {
            "id": Идентификатор локации (str),
            "name": Название локации (str),
            "category": Категория локации (str),
            "description": Описание локации (str),
            "coordinates": Координаты (list int)
        },
        ...
    ]
}

Получить отзывы места

Возвращает по идентификатору места отзывы и их оценки.

Адрес API

GET /api/v2024/<site>/get_reviews_by_id/?id=<id>

Параметры

Параметр	Тип	Описание
`site`	string	Название сайта на латинице
`id`	string	Идентификатор локации

Ответ

JSON-объект со следующей структурой:

[
    {
        "review": отзыв (str),
        "rating": рейтинг (int),
    },
    ...
]

Получить посещаемость места

Возвращает по идентификатору места посещаемость по дням недели в количестве человек.

Адрес API

GET /api/v2024/<site>/get_visits_by_id/?id=<id>

Параметры

Параметр	Тип	Описание
`site`	string	Название сайта на латинице
`id`	string	Идентификатор локации

Ответ

JSON-объект со следующей структурой:

{
    "понедельник": int,
    "вторник": int,
    "среда": int,
    "четверг": int,
    "пятница": int,
    "суббота": int,
    "воскресенье": int
}

Получить количественные показатели места

Возвращает по идентификатору места.

Адрес API

GET /api/v2024/<site>/get_stats_by_id/?id=<id>

Параметры

Параметр	Тип	Описание
`site`	string	Название сайта на латинице
`id`	string	Идентификатор локации

Ответ

JSON-объект со следующей структурой:

{
    "ratings": оценки отзывов (list int),
    "visits": посещаемость (dict),
    "likes": число лайков (int)
}

Получить среднюю посещаемость места

Возвращает по идентификатору места среднюю загрузку (посещаемость).

Адрес API

GET /api/v2024/<site>/get_average_visits_by_id/?id=<id>

Параметры

Параметр	Тип	Описание
`site`	string	Название сайта на латинице
`id`	string	Идентификатор локации

Ответ

JSON-объект со следующей структурой:

{
    "avg_visits": среднее число посещений (int)
}