API и сервисы

«Свадьба в Таганроге» предоставляет свой API, позволяющий получить любые интересующие данные из каталога в нескольких форматах.
Кому могут пригодиться эти инструменты?

Рекламодателям, размещающим объявления

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

Разработчикам сайтов о мероприятиях в Таганроге и области

Если у Вас есть портал на тему мероприятий (в особенности — свадеб), при помощи нашего API Вы можете получить подробную базу объявлений свадебных специалистов разного профиля. Эта база позволит быстро и практически без затрат труда и времени наполнить Ваш собственный каталог специалистов-свадебщиков.
Как тарифицируется использование API?
Запросы к API портала делятся на три типа: служебные (Internal), одиночные (Single) и множественные (Multiple). Служебные запросы необходимы для выполнения действий на самом сайте и, в большинстве случаев, не возвращают никакой информации. Одиночные запросы позволяют получить информацию об одном конкретном элементе (объявление или категория) и не имеют ограничений на использование при использовании вывода в формате изображения (Image). Множественные запросы, получающие информацию о группе элементов (все объявления в категории, все категории каталога) и одиночные запросы при выводе в формате JSON имеют ограничение на количество запросов в час — не более 25. При превышении этого ограничения API вместо результата будет выдавать ошибку.
Что делать при превышении лимита?
Если Вам требуется увеличить максимальное количество множественных запросов к API, Вы можете рассмотреть коммерческий (до 100 запросов в час) и энтерпрайз (безлимитное использование API) тарифы использования API.
Информация и коммерческое предложения по этим тарифам высылаются индивидуально при обращении на почту svadbavtaganroge@yandex.ru

Структура запросов
Входные данные
Все запросы к API строятся по одной структуре:
https://svadbavtaganroge.ru/api/?action=имя-запроса&arguments=аргументы&format=формат
Параметр arguments является необязательными для некоторых запросов, параметр format необязателен для всех (по умолчанию равен json). Параметр arguments в качестве значения принимает JSON-объект со свойствами, указанными ниже для каждого запроса, format — значения json и image.
Вывод
В зависимости от значения параметра format результат выполнения запроса будет различаться: image выводит готовое изображение в формате png с необходимыми данными, json выводит JSON-объект, структура которого описана индивидуально для каждого запроса ниже.

Одиночные запросы

get-item
Получает информацию об объявлении.
Аргументы
alias
String; Обязательный параметр. Алиас объявления. Может быть взят из ссылки на объявление: к примеру, в ссылке https://svadbavtaganroge.ru/veduwie/veduwiy-ivan-ivanov выделенная жёлтым часть будет являться алиасом.
Вывод
status
success или error, в зависимости от результата выполнения.
message
Текст сообщения, поясняющего результат выполнения запроса. К примеру, описание ошибки или «Элементы загружены» для успешного выполнения.
lastState
Код состояния, полученный при выполнении запроса. Доступные варианты для этого запроса:
  • items_loaded — элемент загружен, запрос выполнен успешно;
  • error_occured — произошла ошибка на стороне сервера;
  • found_nothing — по запросу ничего не найдено;
  • wrong_arguments — переданы неверные аргументы запроса;
output
Массив с единственным элементом — объектом типа Объявление (Item).

get-category
Получает информацию о категории каталога.
Аргументы
alias
String; Обязательный параметр. Алиас категории. Может быть взят из ссылки на категорию: к примеру, в ссылке https://svadbavtaganroge.ru/veduwie выделенная жёлтым часть будет являться алиасом.
Вывод
status
success или error, в зависимости от результата выполнения.
message
Текст сообщения, поясняющего результат выполнения запроса. К примеру, описание ошибки или «Элементы загружены» для успешного выполнения.
lastState
Код состояния, полученный при выполнении запроса. Доступные варианты для этого запроса:
  • categories_loaded — элемент загружен, запрос выполнен успешно;
  • error_occured — произошла ошибка на стороне сервера;
  • found_nothing — по запросу ничего не найдено;
  • wrong_arguments — переданы неверные аргументы запроса.
output
Массив с единственным элементом — объектом типа Категория (Category).

Множественные запросы

get-items
Получает объявления из категории.
Аргументы
category
String; Обязательный параметр. Алиас категории. Может быть взят из ссылки на категорию: к примеру, в ссылке https://svadbavtaganroge.ru/veduwie выделенная жёлтым часть будет являться алиасом.
count
Number; Обязательный параметр. Количество объявлений, которые необходимо загрузить.
items
Array; Необязательный параметр. Массив числовых идентификаторов объявлений, которые необходимо исключить из вывода.
Вывод
status
success или error, в зависимости от результата выполнения.
message
Текст сообщения, поясняющего результат выполнения запроса. К примеру, описание ошибки или «Элементы загружены» для успешного выполнения.
lastState
Код состояния, полученный при выполнении запроса. Доступные варианты для этого запроса:
  • items_loaded — элементы загружены, запрос выполнен успешно;
  • error_occured — произошла ошибка на стороне сервера;
  • found_nothing — по запросу ничего не найдено;
  • wrong_arguments — переданы неверные аргументы запроса.
output
Массив объектов типа Объявление (Item).

get-categories
Получает информацию обо всех категориях каталога
Аргументы
— данный запрос не принимает аргументов
Вывод
status
success или error, в зависимости от результата выполнения.
message
Текст сообщения, поясняющего результат выполнения запроса. К примеру, описание ошибки или «Элементы загружены» для успешного выполнения.
lastState
Код состояния, полученный при выполнении запроса. Доступные варианты для этого запроса:
  • categories_loaded — элементы загружены, запрос выполнен успешно;
  • error_occured — произошла ошибка на стороне сервера.
output
Массив объектов типа Категория (Category).

Внутренние запросы

auth-vk
Пробует авторизоваться на сайте через ВКонтакте.
Аргументы
— данный запрос не принимает аргументов
Вывод
— в случае успешного выполнения, данный запрос не возвращает ничего
status
Может быть только error.
message
Текст ошибки.
lastState
Код ошибки:
  • error_occured — произошла ошибка на стороне сервера;
  • 3rd_party_error — ошибка на сервере ВКонтакте.
Перенаправления
— в ходе обработки, запрос осуществляет перенаправление на страницу авторизации пользователя в приложении «Свадьба в Таганроге» ВКонтакте
— при успешном завершении, запрос перенаправляет пользователя на страницу входа на сайт (https://svadbavtaganroge.ru/login)

Типы объектов вывода

Объявление (Item)
Объявление из каталога.
Поля
id
Number; Внутренний числовой идентификатор объявления
name
String; Заголовок объявления
created
String; Дата создания объявления
rating
Number; Рейтинг объявления
hits
Number; Количество просмотров
category_id
Number; Внутренний числовой идентификатор категории
category_alias
String; Алиас категории
gallery_type
String; Тип галереи, принимает два возможных значения:
  • instagram — галерея синхронизирована с аккаунтом Instagram, фотографии «подтягиваются» оттуда;
  • gallery — статическая галерея из изображений, хранящихся на сайте.
comments_count
Number; Количество отзывов
videos_count
Number; Количество видео
images_count
Number; Количество фотографий в основном альбоме. При значении gallery_type равном gallery — целое число больше или равное нулю, при значении instagram всегда -1
tariff
Number; Номер тарифа. Принимает три возможных значения:
  • 0 — стандарт;
  • 1 — визитная карточка;
  • 2 — VIP;
tariff_name
String; Название тарифа. Принимает три возможных значения:
  • standard — стандарт;
  • visit_card — визитная карточка;
  • vip — VIP;
url
URI; Прямая ссылка на объявление
avatar
URI; Прямая ссылка на аватар объявления
bg
URI; Прямая ссылка на фоновое изображение объявления
text
String; Текст объявления без HTML-разметки
price_hour
Number; Цена за час. Если таковая не указана, значение будет равно нулю
price_day
Number; Цена за день. Если таковая не указана, значение будет равно нулю

Категория (Category)
Категория каталога.
Поля
id
Number; Внутренний числовой идентификатор категории
name
String; Заголовок объявления
items_count
Number; Количество объявлений в категории
url
URI; Прямая ссылка на категорию

Подпишитесь на наши новости