Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 44 Next »

Для получения данных по экскурсиям используейте метод https://experience.tripster.ru/api/experiences/.

Параметры запроса

  • Фильтры

    • city фильтр по ID города

    • city__name_ru фильтр по названию города на русском

    • city__name_en фильтр по названию города на английском

    • city__iata фильтр по коду IATA города

    • citytag фильтр по ID рубрики

    • guide фильтр по ID гида

    • exp_format фильтр по типу экскурсии (exp_format=9 – онлайн-экскурсии)

  • Сортировка

    • sorting=popularity по популярности экскурсии в городе (sorting=-popularity по убыванию, sorting=popularity по возрастанию)

    • sorting=price по цене

  • Набор данных

    • detailed=false сокращенный набор полей. Используйте для загрузки списка экскурсий и отображения его у себя в реальном времени. 

    • detailed=true расширенный набор полей. Используйте для загрузки полных данных по экскурсиям к себе в БД, а также для отображения одной экскурсии в реальном времени. По умолчанию включен при запросе конкретной экскурсии по ID

  • Запрос обновленных данных

    • updated_after=YYYY-MM-DD или YYYY-MM-DD HH:MM:SS будут возвращены экскурсии, которые изменились с этого времени

  • Стандартные параметры format и page_size/per_page, прочитайте про постраничную загрузку данных

Структура ответа

Пример ответа API
{
    "count": 239,
    "next": "https://experience.tripster.ru/api/experiences/?page=2",
    "previous": null,
    "results": [
        {
            "id": 13443,
            "title": "По Тбилиси — душевно и зажигательно!",
            "tagline": "Запах свежего хлеба, звуки «итальянских двориков», потайные пути и знаковые уголки города",
            "url": "https://experience.tripster.ru/experience/13443/",
            "annotation": "Моя экскурсия — это воодушевляющая комбинация фактов о Тбилиси, колоритных историй, песен и тостов. Так и только так можно знакомиться с ярким восточно-южным городом, где всё древнее и ветхое, но дорогое сердцу сплетается с космополитическим и современным. Здесь приглашают на свой балкон и угощают кофе, здесь за старой аркой прячется караван-сарай, а за стеклянными стенами — министерство юстиции. Я покажу вам все грани города — вы никогда не забудете Тбилиси от Мариам.",
            "description": "...Полное описание экскурсии...",
            "type": "group",
            "instant_booking": true,
            "child_friendly": true,
            "max_persons": 20,
            "duration": 4.0,
            "movement_type": "foot",
            "meeting_point": {
                "text": "на площади Свободы"
            },
            "price": {
                "value": 12.0,
                "currency": "EUR",
				"currency_rate": "88.0",
                "price_from": false,
                "unit_string": "за человека",
                "value_string": "€12 за человека",
                "discount": {
                    "value": 0.4,
                    "expiration_date": "2019-01-31",
                    "expiration_text": "еще 3 дня",
                    "original_price": 20.0
                }
            },
            "review_count": 595,
            "rating": 4.95,
            "popularity": 104487,
            "schedule": {
                "text": "ежедневно в 15:00"
            },
            "cover_image": "https://experience-ireland.s3.amazonaws.com/thumbs2/bd68c2f9-852c-11e8-9de2-0ac55974a77a.870x490.jpg",
            "city": {
                "id": 60,
                "name_ru": "Тбилиси",
                "name_en": "Tbilisi",
                "iata": "TBS",
                "country": {
                    "id": 136,
                    "name_ru": "Грузия",
                    "name_en": "Georgia",
                    "currency": "EUR",
                    "in_obj_phrase": "в Грузии",
                    "experience_count": 297,
                    "url": "https://experience.tripster.ru/destinations/georgia/"
                },
                "experience_count": 239,
                "in_obj_phrase": "в Тбилиси",
                "url": "https://experience.tripster.ru/experience/Tbilisi/",
                "image": {
                    "thumbnail": "https://experience-ireland.s3.amazonaws.com/photos/e82d4032-68a7-4e2a-8644-35017cc40326.jpg"
                }
            },
            "guide": {
                "id": 134910,
                "first_name": "Мариам",
                "url": "https://experience.tripster.ru/guide/134910/",
                "avatar": {
                    "small": "https://experience-ireland.s3.amazonaws.com/avatar/3d1c677e-6dcd-11e8-a49f-6e714efd800d.31x31.jpg",
                    "medium": "https://experience-ireland.s3.amazonaws.com/avatar/3d100b46-6dcd-11e8-a49f-6e714efd800d.150x150.jpg"
                },
                "rating": 4.94568245125348,
                "review_count": 718,
                "avg_reaction_delay": null,
                "guide_type": "guide",
                "description": "Привет, меня зовут Мариам, и быть гидом — это не просто моя профессия, а призвание, зов души. Я жарко люблю Тбилиси и жажду им делиться со всеми окружающими. Обожаю встречать новых людей и зажигать в них любовь к своему родному городу. Работаю гидом уже много лет, но, кажется, с каждым годом становится еще интереснее. \r\nОчень хорошо знаю историю Грузии, ее культуру, искусство, мифологию, но не перестаю познавать дальше, чтобы ее больше влюбить вас в город. А еще я научу вас петь и танцевать настоящие грузинские песни и танцы."
            },
            "tags": [
                {
                    "id": 284,
                    "name": "Обзорные",
                    "experience_count": 70,
                    "url": "https://experience.tripster.ru/experience/Tbilisi/284-obzornyie/"
                }
            ],
            "photos": [
                {
                    "thumbnail": "https://experience-ireland.s3.amazonaws.com/thumbs2/0ec94796-7423-11e8-b58a-6e714efd800d.384x289.jpg",
                    "medium": "https://experience-ireland.s3.amazonaws.com/thumbs2/9f215800-6dc6-11e8-a648-6e714efd800d.800x600.jpg"
                },
                {
                    "thumbnail": "https://experience-ireland.s3.amazonaws.com/thumbs2/a2ab16dc-6dc6-11e8-944c-6e714efd800d.384x289.jpg",
                    "medium": "https://experience-ireland.s3.amazonaws.com/thumbs2/a2dd9648-6dc6-11e8-944c-6e714efd800d.800x600.jpg"
                }
            ],
            "links": {
                "reviews": "https://experience.tripster.ru/api/experiences/13443/reviews"
            },
			"status": "active"
        }
    ]
}

Описание ответа

Параметр

Описание

Тип

id

ID экскурсии в Трипстере

Число

status

active для активных экскурсий, в случае запроса с параметром updated_after, могут быть возвращены экскурсии со статусом inactive

Строка

title

Название экскурсии

Строка

tagline

Пояснение к названию для вывода в списке экскурсии

Строка

annotation

Краткое описание экскурсии для вывода на странице экскурсии. Отображается, если передать параметр detailed=true

Строка

description

Подробное описание экскурсии для вывода на странице экскурсии. Отображается, если передать параметр detailed=true

Строка

url

Ссылка на страницу экскурсии на Трипстере (прочитайте про правила формирования ссылок)

Строка

type

Тип экскурсии: private – индивидуальная, group – групповая

Строка

movement_type

Тип передвижения: foot - Пешком, car - На машине, bicycle - На велосипеде, bus - На автобусе, motorcycle - На мотоцикле, watership - На кораблике, other - Другое

Строка

instant_booking

Возможно ли моментальное бронирование экскурсии без ожидания подтверждения от гида: true или false

Boolean

child_friendly

Подходит ли экскурсия детям: true или false

Boolean

max_persons

Максимальное число участников экскурсии

Число

duration

Продолжительность экскурсии в часах

Float

price

Объект с данными о цене экскурсии (посмотрите на картинку с объяснением параметров)

Объект

price.value

Цена экскурсии

Float

price.currency

Валюта экскурсии, совпадает с валютой страны

Строка

price.currency_rate

Курс валюты экскурсии в рублях

Float

price.price_from

Точная ли цена или это "цена от": false –  точная, true – цена "от"

Boolean

price.unit_string

Тип цены "за человека" или "за экскурсию"

Строка

price.value_string

Сформированная строка с описанием цены экскурсии, по которой можно проверить понимание остальных параметров

Строка

price.discount

Объект со скидкой на экскурсию, или null, если скидки нет

Объект

price.discount.value

Размер скидки, "0.3" значит скидку 30%

Float

price.discount.expiration_date

Дата окончания действия скидки, скидка предоставляется для всех заказов, сделанных до этой даты

Дата в формате YYYY-MM-DD

price.discount.expiration_text

Подсказка о скором завершении действии скидки. Например, "еще 3 дня"

Строка

price.discount.original_price

Оригинальная цена до скидки, чтобы показать ее зачеркнутой

Float

review_count

Количество отзывов

Число

rating

Рейтинг экскурсий от 0 до 5

Float

popularity

Индекс популярности, его можно использовать для самостоятельной сортировке экскурсий по популярности

Число

schedule

Объект расписания экскурсии. Отображается, если передать параметр detailed=true

Объект

schedule.text

Расписание экскурсии "ежедневно в 10:00". Отображается, если передать параметр detailed=true

Строка

cover_image

Ссылка на фото обложки экскурсии. Отображается, если передать параметр detailed=true

Строка

meeting_point

Объект с данными о месте встречи

Объект

meeting_point.text

Строка с описанием места встречи. Может быть пустой строкой ""

Строка

city

Объект с данными о городе экскурсии

Объект

guide

Объект с данными о гиде

Объект

guide.guide_type

Типа гида: guide -Гид, team - Представитель команды гидов, agency - Представитель агентства

Строка

tags

Список рубрик, к которым привязана экскурсия в городе

Список

photos

Список фотографий экскурсии, первая в списке фотография – для использования в листинге экскурсий. Если передать параметр detailed=true, отобразятся все фотографии. Если detailed=false – только первая.

Список

photos.thumbnail

Ссылка на картинку-превьюшку города размером 384x289px

Строка

photos.medium

Ссылка на картинку-превьюшку города размером 800x600px

Строка

Запрос обновленных данных

Для того, чтобы получить список экскурсий, обновленных после определенного момента времени, сделайте запрос с параметром updated_after. API вернет список активных экскурсий, которые были обновлены с этого времени, а также список экскурсий, ставших недоступными для бронирования. Неактивные экскурсии описываются в массиве results в сокращенном формате:

Пример ответа API
// обновлённая экскурсия, ставшая неактивной, отдаются только поля id, status
{
	"id": 13443,
	"status": "inactive"
},

// обновлённая активная экскурсия, отдаются все поля
{
            "id": 13526,
            "title": "Отправить открытку из Эрмитажа",
            "tagline": "Прикоснуться к великолепию дворца и музейных коллекций и найти среди экспонатов то, что по душе",
            "url": "https://experience.tripster.ru/experience/13526/",
            "type": "private",
            "instant_booking": false,
            "child_friendly": true,
            "max_persons": 6,
            "duration": 2.5,
            "price": {
                "value": 3500.0,
                "currency": "RUB",
				"currency_rate": "1.0",
                "price_from": false,
                "unit_string": "за экскурсию",
                "value_string": "3500 руб. за экскурсию",
                "discount": null
            },
            "review_count": 79,
            "rating": 5.0,
            "popularity": 94697,
            "city": {
                "id": 144,
                "name_ru": "Санкт-Петербург",
                "name_en": "Saint Petersburg",
                "iata": "LED",
                "country": {
                    "id": 238,
                    "name_ru": "Россия",
                    "name_en": "Russia",
                    "currency": "RUB",
                    "in_obj_phrase": "по России",
                    "experience_count": 956,
                    "url": "https://experience.tripster.ru/destinations/russia/"
                },
                "experience_count": 217,
                "in_obj_phrase": "по Санкт-Петербургу",
                "url": "https://experience.tripster.ru/experience/Saint_Petersburg/",
                "image": {
                    "thumbnail": "https://experience-ireland.s3.amazonaws.com/photos/289a4107-da01-4842-9f14-c548eecaefe5.jpg"
                },
                "utc_offset": 10800.0
            },
            "guide": {
                "id": 135416,
                "first_name": "Александра",
                "url": "https://experience.tripster.ru/guide/135416/",
                "avatar": {
                    "small": "https://experience-ireland.s3.amazonaws.com/avatar/8946e753-99a9-11e8-b5d4-0ac55974a77a.31x31.jpg",
                    "medium": "https://experience-ireland.s3.amazonaws.com/avatar/8946e752-99a9-11e8-b5d4-0ac55974a77a.150x150.jpg"
                },
                "rating": 5.0,
                "review_count": 84,

            },
            "tags": [
                {
                    "id": 170,
                    "name": "Музеи и искусство",
                    "experience_count": 16,
                    "url": "https://experience.tripster.ru/experience/Saint_Petersburg/170-muzei-i-iskusstvo/"
                }
            ],
            "photos": [
                {
                    "thumbnail": "https://experience-ireland.s3.amazonaws.com/thumbs2/b26010fc-90e7-11e8-b5d2-0ac55974a77a.384x289.jpg",
                    "medium": "https://experience-ireland.s3.amazonaws.com/thumbs2/a8e33a7e-90e7-11e8-b5d2-0ac55974a77a.800x600.jpg"
                }
            ],
            "links": {
                "reviews": "https://experience.tripster.ru/api/experiences/13526/reviews/"
            },
            "status": "active"
        },

Альтернативный формат цены

Для того, чтобы получить альтернативное описание объекта price, сделайте запрос списка экскурсий с параметром price_format=detailed либо конкретной экскурсии с параметром price_format=detailed

Пример ответа API
{
    "id": 14205,
    "title": "Секретные места Васильевского Острова",
    "tagline": "Прогуляться по самому таинственному району Петербурга, погружаясь в историю и быт ушедшей эпохи",
    "url": "https://experience.tripster.ru/experience/14205/",
    "is_new": false,
    "type": "group",
    "instant_booking": true,
    "child_friendly": true,
    "max_persons": 15,
    "duration": 2.0,
    "meeting_point": {
        "text": "у станции метро Спортивная 2"
    },
    "price": {
        "currency": "RUB",
        "currency_rate": 1.0,
        "onsite_payment": 0.2,
        "per_person": [
            {
                "id": 3917702062,
                "title": "Стандартный билет",
                "is_default": true,
                "value": 750.0
            },
            {
                "id": 2627454350,
                "title": "Дети 8-14 лет",
                "is_default": false,
                "value": 550.0
            },
            {
                "id": 193973751,
                "title": "Дети до 7 лет",
                "is_default": false,
                "value": 0.0
            },
            {
                "id": 219959599,
                "title": "Пенсионеры",
                "is_default": false,
                "value": 550.0
            }
        ],
        "value_string": "750 руб. за человека",
        "price_description": "750 руб. за человека"
    },
    "review_count": 41,
    "rating": 4.63,
    "popularity": 120016,
    "city": {
        "id": 144,
        "name_ru": "Санкт-Петербург",
        "name_en": "Saint Petersburg",
        "iata": "LED",
        "country": {
            "id": 238,
            "name_ru": "Россия",
            "name_en": "Russia",
            "currency": "RUB",
            "in_obj_phrase": "по России",
            "experience_count": 2109,
            "url": "https://experience.tripster.ru/destinations/russia/",
            "region": "CIS"
        },
        "experience_count": 324,
        "in_obj_phrase": "по Санкт-Петербургу",
        "from_obj_phrase": "из Санкт-Петербурга",
        "url": "https://experience.tripster.ru/experience/Saint_Petersburg/",
        "image": {
            "cover": "https://experience-ireland.s3.amazonaws.com/photos/9786aef6-24da-4d86-8860-3170b1484ca1.jpg",
            "thumbnail": "https://experience-ireland.s3.amazonaws.com/photos/4518c77e-c10a-4e0c-9c48-7b33c7eb0273.jpg"
        },
        "utc_offset": 10800.0,
        "ascii_name": "Saint_Petersburg"
    },
    "guide": {
        "id": 27745,
        "first_name": "Алексей",
        "url": "https://experience.tripster.ru/guide/27745/",
        "avatar": {
            "small": "https://experience-ireland.s3.amazonaws.com/avatar/43eeb1da-04e9-11e8-954d-6e714efd800d.31x31.jpg",
            "medium": "https://experience-ireland.s3.amazonaws.com/avatar/43bc3264-04e9-11e8-954d-6e714efd800d.150x150.jpg"
        },
        "rating": 4.69,
        "review_count": 1254,
    },
    "tags": [
        {
            "id": 11669,
            "name": "Групповые",
            "slug": "group",
            "url": "https://experience.tripster.ru/experience/Saint_Petersburg/group/",
            "experience_count": 98,
        }
    ],
    "photos": [
        {
            "thumbnail": "https://experience-ireland.s3.amazonaws.com/thumbs2/796b405a-7ba5-11ea-b160-025c4c6e7a28.384x289.jpg",
            "medium": "https://experience-ireland.s3.amazonaws.com/thumbs2/4ed31162-0ae4-11ea-9e6d-02b782d69cda.800x600.jpg"
        }
    ],
    "links": {
        "reviews": "https://experience.tripster.ru/api/experiences/14205/reviews/",
        "schedule": "https://experience.tripster.ru/api/experiences/14205/schedule/"
    },
    "status": "active"
}

Описание особых параметров объекта price в альтернативном формате цены

В зависимости от выбранной гидом ценовой модели (человек/группа) будет передаваться параметр per_person или per_group

Параметр

Описание

Тип

onsite_payment

Процент стоимости, оплачиваемой на сайте.

Значение 0.2 означает, что 20% пользователь оплатит онлайн, а 80% гиду на месте

Float

В зависимости от выбранной гидом ценовой модели (человек/группа) будет передаваться параметр per_person или per_group

per_person

Объект, содержащий информацию о стоимости экскурсии за человека.

Зачастую в объекте передается единственный элемент со стандартной ценой. Но в случае, если стоимость зависит от категории билета, то объект содержит несколько значений для разных категорий.

Цена из первой категории - всегда основная.

Список возможных категорий не фиксированный, гид добавляет свои варианты при добавлении экскурсии (id для вариантов эмулируется налету из названия)

Объект

per_group

Объект с ценой за экскурсию

Объект



  • No labels