Информация для разработчиков

Для интеграции со сторонними системами на портале реализовано АПИ выгрузки данных в JSON формате. АПИ реализует необходимые методы для получения данных и структуры наборов с портала. Текущая версия АПИ v1.

Узнать текущую версию АПИ:

/api или /api/version

Ответ: {"version":1}

Русскоязычные символы в возвращаемых JSON даных кодированы в 16-ричном формате в целях обеспечения целостности передаваемых данных. Далее в примерах приводятся ответы уже декодированные стандартными средствами консоли веб браузера.

Получить список наборов данных

Запрос:

/api/v1/datasets

Ответ:

{datasets: [{Id: "2118", Name: "Органы ЗАГС", CreatedDate: "2018.11.15", CategoryId: "1"},…], count: 7} count: 7 datasets: [{Id: "2118", Name: "Органы ЗАГС", CreatedDate: "2018.11.15", CategoryId: "1"},…] 0: {Id: "2118", Name: "Органы ЗАГС", CreatedDate: "2018.11.15", CategoryId: "1"} CategoryId: "1" CreatedDate: "2018.11.15" Id: "2118" Name: "Органы ЗАГС" 1: {Id: "2138", Name: "Места для пикника", CreatedDate: "2018.11.15", CategoryId: "3"} CategoryId: "3" CreatedDate: "2018.11.15" Id: "2138" Name: "Места для пикника" 2: {Id: "3000", Name: "Адреса катков Самары", CreatedDate: "2018.12.17", CategoryId: "3"} CategoryId: "3" CreatedDate: "2018.12.17" Id: "3000" Name: "Адреса катков Самары" 3: {Id: "2122", Name: "Аптеки", CreatedDate: "2018.11.15", CategoryId: "4"} CategoryId: "4" CreatedDate: "2018.11.15" Id: "2122" Name: "Аптеки" 4: {Id: "3014", Name: "Адреса больниц Самары", CreatedDate: "2018.12.17", CategoryId: "4"} CategoryId: "4" CreatedDate: "2018.12.17" Id: "3014" Name: "Адреса больниц Самары" 5: {Id: "2125", Name: "Wi-Fi в парках", CreatedDate: "2018.11.15", CategoryId: "5"} 6: {Id: "3042", Name: "Адреса полиций Самары", CreatedDate: "2018.12.18", CategoryId: "40"}

Получить структуру набора с идентификатором 3000

Запрос:

/api/v1/datasets/3000

Ответ:

{Id: "3000", Name: "Адреса катков Самары", Description: "",…} CategoryId: "3" Columns: [{code: "STRUCTURE_5c176c15a825f3_19062649", name: "Краткое название", type: "S"},…] 0: {code: "STRUCTURE_5c176c15a825f3_19062649", name: "Краткое название", type: "S"} code: "STRUCTURE_5c176c15a825f3_19062649" name: "Краткое название" type: "S" 1: {code: "STRUCTURE_5c176c15a9b9c4_50806826", name: "Адрес", type: "S"} code: "STRUCTURE_5c176c15a9b9c4_50806826" name: "Адрес" type: "S" 2: {code: "STRUCTURE_5c176c15aa7a03_85975224", name: "Время работы", type: "S"} code: "STRUCTURE_5c176c15aa7a03_85975224" name: "Время работы" type: "S" 3: {code: "STRUCTURE_5c176c15abb125_90842458", name: "Телефон", type: "S"} code: "STRUCTURE_5c176c15abb125_90842458" name: "Телефон" type: "S" 4: {code: "STRUCTURE_5c176c15ae6346_18087875", name: "Индекс", type: "S"} code: "STRUCTURE_5c176c15ae6346_18087875" name: "Индекс" type: "S" 5: {code: "STRUCTURE_5c176c15b05671_12027138", name: "Долгота", type: "S"} code: "STRUCTURE_5c176c15b05671_12027138" name: "Долгота" type: "S" 6: {code: "STRUCTURE_5c176c15b2a1f7_38043260", name: "Широта", type: "S"} code: "STRUCTURE_5c176c15b2a1f7_38043260" name: "Широта" type: "S" CreatedDate: "2018.12.17" Description: "" Id: "3000" Name: "Адреса катков Самары" Url: "/datasets/leisure-and-recreation/3000/"

Получить количество строк в наборе с идентификатором 3000

Запрос:

/api/v1/datasets/3000/count

Ответ:

10

Получить количество страниц постраничной выдачи для набора с идентификатором 3000

Запрос:

/api/v1/datasets/3000/pages

Ответ:

1

Получить порцию (100) строк набора с идентификатором 3000

Запрос:

/api/v1/datasets/3000/rows

Ответ:

{3001: {Краткое название: "Ипподром Арена", Адрес: "пр. Кирова, 320а", Время работы: "7:00-22:00",…},…} 3001: {Краткое название: "Ипподром Арена", Адрес: "пр. Кирова, 320а", Время работы: "7:00-22:00",…} Адрес: "пр. Кирова, 320а" Время работы: "7:00-22:00" Долгота: "53.253805" Индекс: "443125" Краткое название: "Ипподром Арена" Телефон: "8 (846) 302-70-22" Широта: "50.217052" 3002: {Краткое название: "Ледовые Узоры", Адрес: " ул. Советской Армии, 181В", Время работы: "12:00-22:01",…} Адрес: " ул. Советской Армии, 181В" Время работы: "12:00-22:01" Долгота: "53.226746" Индекс: "443081" Краткое название: "Ледовые Узоры" Телефон: "8 (846) 926-17-44" Широта: "50.197392" 3003: {Краткое название: "Площадь Куйбышева", Адрес: " пл. Куйбышева", Время работы: "без ограничений",…} Адрес: " пл. Куйбышева" Время работы: "без ограничений" Долгота: "53.196257" Индекс: "443010" Краткое название: "Площадь Куйбышева" Телефон: "отстутствует" Широта: "50.102617" 3004: {Краткое название: "Ледовый каток ICE CITY", Адрес: "ТРК Аврора, ул. Аэродромная, 47а",…} Адрес: "ТРК Аврора, ул. Аэродромная, 47а" Время работы: "10:00-01:15" Долгота: "53.191247" Индекс: "443070" Краткое название: "Ледовый каток ICE CITY" Телефон: "8 (846) 990-70-57" Широта: "50.189093" 3005: {Краткое название: "Динамо", Адрес: "ул. Льва Толстого, 97А", Время работы: "без ограничений",…} 3006: {Краткое название: "Торпедо-4", Адрес: "ул. Мичурина, 90", Время работы: "без ограничений",…} 3007: {Краткое название: "Восход", Адрес: "пр. Кирова, 85", Время работы: "без ограничений",…} 3008: {Краткое название: "Дзержинка", Адрес: "ул. Пионерская, 21А", Время работы: "7:00-22:00",…} 3009: {Краткое название: "Локомотив", Адрес: "ул. Агибалова, 7", Время работы: "7:00-22:00",…} 3010: {Краткое название: "Ледовый дворец "Кристалл"", Адрес: "Московское ш., 50",…}

Во избежание большой нагрузки на сервер данные наборов выдаются по 100 записей на страницу Для переключения страницы в запрос добавляется параметр page

/api/v1/datasets/3000/rows?page=2