Разработчикам

Раздел разработчикам, посвящен использованию информации от нашего сервиса на своих проектах. Мы предоставим различные инструменты (виджеты), для интеграции наших сервисов на ваши проекты, такие как карты с проблемами (с выбором по тематике), списки проблем и т.д.

При использовании данных, полученных с использованием API Томского мнения, необходимо указывать источник данных, размещая ссылку (активную) на сайт проекта Томское мнение: http://tomsk.mn.

Запрещено любое коммерческое использование данных, полученных с использованием API Томского мнения. Так же запрещается ограничивать доступ к данным, полученным с использованием API Томского мнения. Если ваш проект имеет закрытую часть (платная или для авторизованных пользователей), размещайте наши данные только в открытом доступе.

Введение

Для работы с API используется следующий формат запросов:http://tomsk.mn/api/[function_name]/[parametrs]

Где, [function_name] - функция API сервиса, а [parametrs] - параметры функции API.

Все функции делятся на свободные и закрытые, для доступа к свободным функциям не требуется регистрация на сайте и получение API KEY, для закрытых функций требуется регистрация и получение API KEY. Все открытые функции позволяют только получать различную информацию от нашего сервиса.

Базовые функции

К базовым функциям относятся открытые функции получения списков существующей активности пользователей.

getlist

Главная функция - getlist, которая возвращает JSON массив, содержащий список активности по заданным параметрам. Существует два вида вызова функции - по умолчанию и с параметрами. http://tomsk.mn/api/getlist http://tomsk.mn/api/getlist/[activity_count];[activity_type];[activity_state]

Вызов по умолчанию вернет последние 100 записей активности пользователей на сайте, всех типов проблем и всех состояний (созданные, открытые или закрытые).

Использование вызова с параметрами требует задачи всех трех параметров. Кроме того, важно соблюдать порядок следования параметров. Параметры друг от друга отделяются символом ";". [activity_count] - количество возвращаемых записей [activity_type] - тип активности

• Дороги и транспорт—1
• Безопасность—7
• Городское хозяйство—14
• ЖКХ—23
• Социальная сфера—24
• Нарушение закона—31

[activity_state] - тип состояния активности

• Любое—0
• Открытое—1
• В работе—2
• Закрытое—3
• Архивированные—4

Пример использования по умолчанию: http://tomsk.mn/api/getlist

Пример использования c параметрами: http://tomsk.mn/api/getlist/param/1;31;0

Возвращаемые параметры

• activity_user — Псевдоним пользователя, если он не указан, то Анонимно
• user_avatar — Аватар пользователя
• activity_id — Идентификатор активности, для организации перехода на сайт по ссылке http://tomsk.mn/activity/show/[activity_id]
• activity_lon — Широта активности, необходима для позиционирования на карте города
• activity_lat — Долгота активности, необходима для позиционирования на карте города
• activity_title — Заголовок активности
• activity_startdate — Дата создания активности
• activity_opendate — Дата принятия активности в работу, ответственными организациями
• activity_enddate — Дата закрытия активности
• activity_description — Описание активности
• activity_voice — Средняя оценка активности по десятибалльной шкале
• activity_nvoice — Количество людей, считающих данную активность важной и оценивших е
• activity_type — Тип активности
• activity_flag — Состояние активности

Картографические сервисы

В своей работе мы используем схему Томска, предоставленную сервисом Интерактивные схемы Томска.

Вы можете разместить у себя на сайте карту активности жителей города Томска. Для этого укажите настройки виджета карты:

Внимание! Не устанавливайте размер виджета менее чем 500 на 400 пикселей, дело в том, что на карте отображаются окошки с описанием активности, они имеют фиксированный размер 250 на 250 писелей.