Документация API / версия 1
Документация
Документация предназначена для разработчиков, желающих использовать API при разработке собственных приложений и веб-сервисов. Для работы с документацией необходимо иметь общее представление о назначении системы, а также иметь понимание принципов использования API в своих приложениях.
Условия использования API
Использование API на своем сайте или для написания собственного клиентского приложения подразумевает согласие с пользовательским соглашением API. Действия клиентского приложения либо сайта не должны противоречить правилам, установленным данным соглашением.
Основные сведения
API предоставляет интерфейс для информационного взаимодействия с порталом открытых данных г.Нижневартовска.
Работа с API осуществляется в соответствии с принципами REST, посредством HTTP-запросов с использованием методов GET. С предлагаемым интерфейсом могут взаимодействовать как веб-сервисы, так и приложения (десктопные либо мобильные). Взаимодействие с API производится только в режиме чтения. Методов для записи данных в систему не предоставляется. API позволяет получать ответ на запросы в формате JSON.
Синтаксис запроса
Чтобы обратиться к API, Вам необходимо выполнить GET запрос такого вида:
https://data.n-vartovsk.ru/api/{VERSION}/{OBJECT}/{METHOD}?{API_KEY}&{PARAMETERS}
Он состоит из нескольких частей:
VERSION
(обязательно) — версия API, к которому Вы хотите обратиться (действующая версия API).
OBJECT
(обязательно) — объект API, к которому Вы хотите обратиться.
METHOD
(обязательно) — метод API, к которому Вы хотите обратиться.
API_KEY
(опционально) — ключ доступа может передоваться любым из предложенных вариантов:
в HTTP Header, в формате
Authorization-Token: 'API_KEY:<ваш ключ>'
параметром в GET-запросе, в формате
?api_key=<ваш ключ>.
PARAMETERS
(опционально) — входные параметры соответствующего метода API, последовательность пар name=value, разделенных амперсандом.
Объекты API
- /api/ - действующая версия API;
- /api/v1/ - перечень объектов в действующей версии API;
- /api/v1/reestr/{METHOD} - реестр открытых данных (для ознакомления перейдите в конструктор запросов);
- /api/v1/{DATASET}/{METHOD} - наборы открытых данных (перечень наборов доступен ниже).
Реестр открытых данных
Реестр наборов открытых данных - систематизированный перечень наборов открытых данных, позволяющий в автоматическом режиме осуществлять навигацию по паспортам наборов открытых данных и получать ключевые параметры этих наборов, включая гиперссылки, необходимые для доступа к наборам открытых данных.
Доступные методы:- /api/v1/reestr/data - данные реестра;
- /api/v1/reestr/cat - справочник категорий реестра;
- /api/v1/reestr/pub - справочник публикаторов реестра.
Наборы открытых данных
Для работы c наборами открытых данных предусмотрена следующая коллекция объектов:
-
/api/v1/8603032896-advertisingconstructions
Информация о торгах на право заключения договоров на установку и эксплуатацию рекламных конструкций
/api/v1/8603032896-agphonedir
Телефонный справочник администрации города Нижневартовска
/api/v1/8603032896-agreementsdai
/api/v1/8603032896-agreementsdkr
/api/v1/8603032896-agreementsek
/api/v1/8603032896-agreementsgchp
/api/v1/8603032896-agreementsiip
/api/v1/8603032896-agreementsik
/api/v1/8603032896-agreementskjc
/api/v1/8603032896-agreementsrip
/api/v1/8603032896-agreementssp
/api/v1/8603032896-agreementszpk
/api/v1/8603032896-agstruct
Структура администрации города Нижневартовска
/api/v1/8603032896-archiveexpertise
Архив проектов правовых актов, в отношении которых проведена антикоррупционной экспертизы в администрации города Нижневартовска
/api/v1/8603032896-archivelistag
Перечень организаций, документы по личному составу которых находятся на муниципальном хранении
/api/v1/8603032896-averagesalary
Информация о среднемесячной заработной плате руководителей, их заместителей и главных бухгалтеров муниципальных учреждений и муниципальных унитарных предприятий города Нижневартовска
/api/v1/8603032896-bgorod
Безопасный город
/api/v1/8603032896-budgetbulletin
Финансовый бюллетень об исполнении бюджета города Нижневартовска
/api/v1/8603032896-budgetinfo
Информация об исполнении бюджета города Нижневартовска по доходам и расходам
/api/v1/8603032896-budgetreport
Отчёты об исполнении бюджета города Нижневартовска
/api/v1/8603032896-buildlist
/api/v1/8603032896-buildpermission
Перечень выданных разрешения на ввод в эксплуатацию жилых домов
/api/v1/8603032896-buildreestr
/api/v1/8603032896-businessevents
План мероприятий в сфере поддержки предпринимательства
/api/v1/8603032896-businessinfo
/api/v1/8603032896-busroute
Перечень маршрутов города Нижневартовска
/api/v1/8603032896-busstation
Остановки общественного транспорта города Нижневартовска
/api/v1/8603032896-citywideevents
/api/v1/8603032896-demography
/api/v1/8603032896-docag
Перечень правовых актов главы города (главы администрации города) Нижневартовска
/api/v1/8603032896-docaglink
Сведения о внесении изменений в правовые акты главы города (главы администрации города) Нижневартовска
/api/v1/8603032896-docagtext
Текст правовых актов главы города (главы администрации города) Нижневартовска
/api/v1/8603032896-dostupnayasreda
Перечень объектов инженерной, транспортной, социальной инфраструктуры города Нижневартовска осуществляющие беспрепятственный доступ инвалидов и других маломобильных групп населения
/api/v1/8603032896-infoprivatization
Информация о приватизации муниципального имущества
/api/v1/8603032896-inforent
Информация о торгах на право заключения договоров аренды муниципального имущества
/api/v1/8603032896-landplotsreestr
Реестр земельных участков, находящихся в государственной или муниципальной собственности
/api/v1/8603032896-listcommunicationequipment
Перечень муниципального имущества для первоочередного размещения оборудования связи, в том числе оборудования базовых станций подвижной радиотелефонной (сотовой) связи
/api/v1/8603032896-listmkd
/api/v1/8603032896-listmkdmanagerorgs
/api/v1/8603032896-listoumd
Перечень УК, ТСЖ, ЖСК осуществляющих свою деятельность на территории города Нижневартовска
/api/v1/8603032896-msgsmp
Информационные сообщения в сфере молодежной политики города Нижневартовска
/api/v1/8603032896-mspsupport
/api/v1/8603032896-ogobsor
Информационно-статистические обзоры обращений граждан
/api/v1/8603032896-opendata2
/api/v1/8603032896-otguid
Методические рекомендации в сфере охраны труда
/api/v1/8603032896-photoreports
Фоторепортажи города Нижневартовска
/api/v1/8603032896-placeelections
/api/v1/8603032896-placesad
/api/v1/8603032896-placesesia
Список пунктов регистрации и подтверждения личности в Единой системе идентификации и аутентификации (ЕСИА)
/api/v1/8603032896-placespk
Подростковые (молодежные) клубы по месту жительства
/api/v1/8603032896-placessg
Спортивные площадки города Нижневартовска
/api/v1/8603032896-placeswinter
/api/v1/8603032896-prglistag
Перечень стратегических планов и программ социально-экономического развития города Нижневартовска
/api/v1/8603032896-propertyregister
/api/v1/8603032896-propertyregisterlands
/api/v1/8603032896-propertyregistermovableproperty
/api/v1/8603032896-propertyregisterrealestate
/api/v1/8603032896-propertyregisterstoks
/api/v1/8603032896-publichearing
Публичные слушания города Нижневартвоска
/api/v1/8603032896-realestatereestr
/api/v1/8603032896-roadcrossingnearshcool
/api/v1/8603032896-roadgasstation
/api/v1/8603032896-roadgasstationprice
/api/v1/8603032896-roadservice
/api/v1/8603032896-roadworks
/api/v1/8603032896-roadworksguarantees
/api/v1/8603032896-sitelenta
Перечень информационных сообщений «Живая лента» размещённых на официальном сайте органов местного самоуправления города Нижневартовска
/api/v1/8603032896-sitenews
Новости официального сайта органов местного самоуправления города Нижневартовска
/api/v1/8603032896-siterubrics
Перечень рубрик официального сайта органов местного самоуправления города Нижневартовска
/api/v1/8603032896-stvpgmu
Справочные телефоны по вопросам предоставления государственных и муниципальных услуг
/api/v1/8603032896-tarif
Тарифы на коммунальные услуги для населения города Нижневартовска
/api/v1/8603032896-territoryplans
Документация по планировке и межеванию территорий города Нижневартовска
/api/v1/8603032896-topnameboys
Сведения о наиболее популярных мужских именах среди новорожденных
/api/v1/8603032896-topnamegirls
Сведения о наиболее популярных женских именах среди новорожденных
/api/v1/8603032896-uchculture
Учреждения культуры города Нижневартовска
/api/v1/8603032896-uchcultureclubs
Клубные формирования в муниципальных учреждениях культуры города Нижневартовска
/api/v1/8603032896-uchdou
Дошкольные образовательные учреждения города Нижневартовска
/api/v1/8603032896-uchgkhservices
Аварийные службы города Нижневартовска
/api/v1/8603032896-uchou
Общеобразовательные учреждения города Нижневартовска
/api/v1/8603032896-uchoudod
Образовательные учреждения дополнительного образования детей города Нижневартовска
/api/v1/8603032896-uchsport
Учреждения спорта города Нижневартовска
/api/v1/8603032896-uchsportsection
Реестр физкультурно-спортивных организаций города Нижневартовска
/api/v1/8603032896-uchsporttrainers
/api/v1/8603032896-videoreports
Видеорепортажи города Нижневартовска
/api/v1/8603032896-wastecollection
Перечень пунктов раздельного сбора отходов расположенных на территории города Нижневартовска
/api/v1/8603032896-winterholiday
Ok