ПРАВИЛА И РЕКОМЕНДАЦИИ
Для разработчиков и опытных пользователей, с целью быстрого получения массивов открытых данных в машиночитаемых форматах на Портале открытых данных Республики Узбекистан реализована возможность подачи запросов посредством API.
API находится в стадии разработки и поэтому методы могут быть изменены без предупреждения, но с последующим информированием пользователей. Для работы с API требуется получить личный ключ, который доступен после регистрации на Портале.
После получения ключа вы можете использовать API. Ключ необходимо прописывать в конце запроса в следующем виде: /?access_token=ваш ключ. Например, для получения списка датасетов полный запрос будет выглядеть следующим образом:http://data.gov.uz/ru/api/v1/json/dataset?access_key...ваш ключ API предлагает несколько форматов вывода результатов запроса. На данный момент поддерживаются следующие форматы:
- JSON (в строке запроса используется название в нижнем регистре «json»)
- XML (в строке запроса используется название в нижнем регистре «xml»)
- CSV (в строке запроса используется название в нижнем регистре «csv»)
Точка доступа в API располагается по адресу: <____/ru/api>
НА ТЕКУЩИЙ МОМЕНТ РЕАЛИЗОВАНЫ СЛЕДУЮЩИЕ ВИДЫ ЗАПРОСОВ:
- Главная страница API;
- Набор открытых данных:
- Перечень наборов открытых данных;
- Версия набора открытых данных:
- Перечень версий набора открытых данных;
- Структура версии набора открытых данных;
- Содержимое файла версии набора открытых данных;
- Перечень организаций:
- Организация;
- Перечень наборов открытых данных организации;
- Перечень сфер;
- Перечень наборов открытых данных по сферам.
Для некоторых запросов возможна дополнительная фильтрация. Перечень доступных фильтраций для каждого набора предоставлен в описании запроса.
Дополнительная фильтрация осуществляется через GET параметры.
Например можно применить дополнительную фильтрацию к запросу получения перечня наборов открытых данных «/ru/api/v1/json/dataset». Для того, чтобы получить все наборы в сфере «Экономика» нужно использовать фильтр «sphere» со значением «5», которое является идентификационным номером данной сферы. Тогда итоговый запрос будет выглядеть так: «/ru/api/v1/json/sphere/5». Все идентификационные номера можно получить через запрос «/ru/api/v1/json/sphere». Если же использовать фильтр «organization» со значением, например «1», которое является идентификационным номером Министерства юстиции Республики Узбекистан, то итоговый запрос будет выглядеть так: «/api/v1/json/organization/1/dataset».
НАЗНАЧЕНИЕ И СТРУКТУРА ЗАПРОСОВ
- Главная страница API - Запрос предназначен для предоставления информации об API, в том числе справочной информации, условиях использования и перечня возможных запросов.
Структура запроса:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>»
- Перечень наборов открытых данных - запрос предназначен для получения перечня наборов открытых данных.
Структура запроса:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)/dataset>»
- Набор открытых данных - запрос предназначен для получения набора открытых данных.
Структура запроса:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/dataset/<dataset:\d+>»
- Перечень версий набора открытых данных - запрос предназначен для получения перечня версий набора открытых данных.
Структура запроса:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/dataset/<dataset:\d+>/version»
- Версия набора открытых данных - Запрос предназначен для получения полной информации о версии набора открытых данных.
Структура запроса:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/dataset/<dataset:\d+>/version\<version:\d+>»
- Структура версии набора открытых данных - Запрос предназначен для получения полной информации о структуре версии набора открытых данных.
Структура запроса:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/dataset/<dataset:\d+>/version\<version:\d+>/structure»
- Содержимое файла версии набора открытых данных - Запрос предназначен для получения содержимого файла версии набора открытых данных.
Структура запроса:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/dataset/<dataset:\d+>/version\<version:\d+>/content»
- Перечень организаций - Запрос предназначен для получения перечня зарегистрированных на портале организаций, предоставляющих открытые данные.
Структура запроса:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/organization»
- Организация - Запрос предназначен для получения полных данных организации, предоставляющей открытые данные.
Структура запроса:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/organization/<organization:\d+>»
- Перечень наборов открытых данных организации - Запрос предназначен для получения перечня наборов открытых данных.
Структура запроса:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/organization/<organization:\d+>/dataset»
- Перечень тематических рубрик - Запрос предназначен для получения перечня тематических рубрик наборов открытых данных.
Структура запроса:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/sphere»
- Тематическая рубрика - Запрос предназначен для получения тематической рубрики.
Структура запроса:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/sphere/<sphere:\d+>»
- Перечень наборов открытых данных по тематической рубрике - Запрос предназначен для получения перечня наборов открытых данных по тематической рубрике.
Структура запроса:
«/<language:(uz|ru)>/api/<api_version:(v1|v2|..)>/<format:(json|xml)>/shpere/<shpere:\d+>/dataset»