Документация API / версия 1 / 8603032896-mspsupport
Документация API по работе с набором открытых данных
Идентификатор набора: 8603032896-mspsupport
Наименование набора: Сведения о мерах поддержки малого и среднего предпринимательства в городе Нижневартовске
С чего начать?
Для работы с API Вам потребуется уникальный ключ доступа. Чтобы получить его — пройдите несложную процедуру идентификации на портале.
Использование ключа доступа
API доступен только зарегистрированным разработчикам.
Ключ доступа может передаваться любым из предложенных вариантов:
в HTTP Header, в формате
Authorization-Token: 'API_KEY:<ваш ключ>'.
в GET-запросе, в формате ?api_key=<ваш ключ>.
Токен (api_key) можно посмотреть в профиле пользователя портала.
Для работы с набором открытых данных предусмотренны следующие API:
- Значение
- Формат
- Адрес
- Паспорт набора
- JSON HTML
- /api/v1/8603032896-mspsupport/passport
- Структура набора
- JSON
- /api/v1/8603032896-mspsupport/structure
- Данные набора
- JSON
- /api/v1/8603032896-mspsupport/data[?param=value]
Паспорт набора
Паспорт набора - cовокупность сведений о наборе открытых данных, позволяющая однозначно идентифицировать такой набор и получить в автоматическом режиме ключевые параметры, характеризующие набор открытых данных.
Структура набора
Структура набора - совокупность сведений о полях набора открытых данных.
Машиночитаемая структура набора открытых данных имеет следующий вид:- Наименование поля
- Тип данных
- Значение поля
- ORGANIZATSIYA_PREDOSTAVLYAYUSHCHAYA_MERU
- String
- Организация, предоставляющая меру поддержки
- VID_MERY_PODDERZHKI
- String
- Вид меры поддержки
- NAIMENOVANIE_MERY_PODDERZHKI
- String
- Наименование меры поддержки
- ZHIZNENNAYA_SITUATSIYA
- String
- Жизненная ситуация
- POLUCHATELI_PODDERZHKI
- String
- Получатели поддержки
- OPISANIE_PROGRAMMY
- String
- Описание программы
- MESTO_REGISTRATSII_ZAYAVITELYA
- String
- Место регистрации заявителя
- USLOVIYA_POLUCHENIYA_PODDERZHKI
- String
- Условия получения поддержки
- VIDY_DEYATELNOSTI
- String
- Виды деятельности
- RAZMER_FINANSOVOY_PODDERZHKI_I_VOZNAGRAZ
- String
- Размер финансовой поддержки и вознаграждение Фонда
- PERECHEN_DOKUMENTOV_PREDOSTAVLYAEMYKH_Z
- String
- Перечень документов, предоставляемых заявителем
- SROKI_POLUCHENIYA_PODDERZHKI
- String
- Сроки получения поддержки
- DATA_PRIEMA_DOKUMENTOV
- String
- Возраст компании
- KONTAKTY_DLYA_DOPOLNITELNOY_INFORMATSII
- String
- Дата приема документов
- VOZRAST_KOMPANII
- String
- Контакты для дополнительной информации
- NAIMENOVANIE_PARAMETRA_1
- String
- Наименование параметра 1
- ZNACHENIE_PARAMETRA_1_MIN
- String
- Значение Параметра 1 мин
Запрос: Ответ:
Данные набора
Данные набора — систематизированная совокупность однотипных данных, представленных в форме открытых данных, состоящая из отдельных элементов, характеризующихся набором атрибутов, и позволяющая автоматизированным системам без участия человека идентифицировать, интерпретировать и обрабатывать такие элементы
Входящие параметры запроса API-Запроса имеет следующий вид:
- Параметр
- Тип данных
- Значение
- ROWS
- Integer
- Количество строк, содержащихся в ответе запроса (может использоваться для навигации по данным
- PAGE
- Integer
- Номер страницы (может использоваться для навигации по данным)
- Q
- String
- Поисковый фильтр, ограничивающий результаты запроса (полнотекстовый поиск по подстроке)
Пример API-запроса: https://data.n-vartovsk.ru/api/v1/8603032896-mspsupport/data?ROWS=2&PAGE=2
Дополнительный поиск по набору осуществляется по следующим полям: ORGANIZATSIYA_PREDOSTAVLYAYUSHCHAYA_MERU, VID_MERY_PODDERZHKI, NAIMENOVANIE_MERY_PODDERZHKI, ZHIZNENNAYA_SITUATSIYA, POLUCHATELI_PODDERZHKI, OPISANIE_PROGRAMMY, MESTO_REGISTRATSII_ZAYAVITELYA, USLOVIYA_POLUCHENIYA_PODDERZHKI, VIDY_DEYATELNOSTI, RAZMER_FINANSOVOY_PODDERZHKI_I_VOZNAGRAZ, PERECHEN_DOKUMENTOV_PREDOSTAVLYAEMYKH_Z, SROKI_POLUCHENIYA_PODDERZHKI, DATA_PRIEMA_DOKUMENTOV, KONTAKTY_DLYA_DOPOLNITELNOY_INFORMATSII, VOZRAST_KOMPANII, NAIMENOVANIE_PARAMETRA_1, ZNACHENIE_PARAMETRA_1_MIN.
Пример API-запроса: https://data.n-vartovsk.ru/api/v1/8603032896-mspsupport/data?ORGANIZATSIYA_PREDOSTAVLYAYUSHCHAYA_MERU=значение
Сортировка по набору осуществляется по следующим полям: ORGANIZATSIYA_PREDOSTAVLYAYUSHCHAYA_MERU, VID_MERY_PODDERZHKI, NAIMENOVANIE_MERY_PODDERZHKI, ZHIZNENNAYA_SITUATSIYA, POLUCHATELI_PODDERZHKI, OPISANIE_PROGRAMMY, MESTO_REGISTRATSII_ZAYAVITELYA, USLOVIYA_POLUCHENIYA_PODDERZHKI, VIDY_DEYATELNOSTI, RAZMER_FINANSOVOY_PODDERZHKI_I_VOZNAGRAZ, PERECHEN_DOKUMENTOV_PREDOSTAVLYAEMYKH_Z, SROKI_POLUCHENIYA_PODDERZHKI, DATA_PRIEMA_DOKUMENTOV, KONTAKTY_DLYA_DOPOLNITELNOY_INFORMATSII, VOZRAST_KOMPANII, NAIMENOVANIE_PARAMETRA_1, ZNACHENIE_PARAMETRA_1_MIN.
Пример API-запроса: https://data.n-vartovsk.ru/api/v1/8603032896-mspsupport/data?SORT=ORGANIZATSIYA_PREDOSTAVLYAYUSHCHAYA_MERU&ORDER=(ASC|DESC)
Ответ на запрос API-запрос
Структура ответа на API-запрос имеет следующий вид:
{ "STATUS": CODE, "RESULT": - OBJECT, } где CODE - Код ответа HTTP (200,400,403,404,500) OBJECT - Объект, имеющий следующую структуру: { "META" : { Мета информация, описывающая ответ "ROWS" : Integer количество строк "PAGE" : Integer номер страницы "ROWS_TOTAL" : Integer общее количество строк, находящихся в ответе "PAGE_TOTAL" : Integer общее количество страниц, находящихся в ответе }, "ROWS" : [ {ОБЪЕКТ} ] }
Запрос: Ответ:
Ok