Правила и рекомендации

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

API находится в стадии разработки и поэтому методы могут быть изменены без предупреждения, но с последующим информированием пользователей.

Для работы с API требуется получить личный ключ, который доступен после регистрации на Портале.

Более подробную и детальную информацию вы можете найти в документации по API.

После получения ключа вы можете использовать API. Ключ необходимо прописывать в конце запроса в следующем виде: /?access_token=ваш ключ. Например, для получения списка датасетов полный запрос будет выглядеть следующим образом: http://data.gov.ru/api/dataset/?access_token=ваш ключ

API предлагает несколько форматов вывода результатов запроса. На данный момент поддерживаются следующие форматы:

  • JSON (в строке запроса используется название в нижнем регистре «json»)
  • XML(в строке запроса используется название в нижнем регистре «xml»)

Точка доступа в API располагается по адресу: <____/api>

На текущий момент реализованы следующие виды запросов:

  1. Главная страница API;

  2. Набор открытых данных:

  3. Перечень наборов открытых данных;

  4. Набор открытых данных;

  5. Версия набора открытых данных:

  6. Перечень версий набора открытых данных;

  7. Версия набора открытых данных;

  8. Структура версии набора открытых данных;

  9. Содержимое файла версии набора открытых данных;

  10. Организация:

  11. Перечень организаций;

  12. Организация;

  13. Перечень наборов открытых данных организации;

  14. Тематическая рубрика:

  15. Перечень тематических рубрик;

  16. Тематическая рубрика;

  17. Перечень наборов открытых данных по тематической рубрике.

Для некоторых запросов возможна дополнительная фильтрация. Перечень доступных фильтраций для каждого набора предоставлен в описании запроса.

Дополнительная фильтрация осуществляется через GET параметры.
Например можно применить дополнительную фильтрацию к запросу получения перечня наборов открытых данных «/api/dataset». Для того, чтобы получить все наборы по тематике «Правительство» нужно использовать фильтр «topic» со значением «Government». Тогда итоговый запрос будет выглядеть так: «/api/dataset?topic=Government». Если же использовать фильтр «organization» со значением, например «7710474375», то итоговый запрос будет выглядеть так: «/api/dataset?organization=7710474375», что равнозначно запросу «/api/organization/7710474375/dataset». Можно комбинировать несколько фильтров, тогда итоговый запрос будет выглядеть так «/api/dataset?topic=Government&organization=7710474375».

Более подробную и детальную информацию вы можете найти в документации по API по адресу: <_______>

Назначение и структура запросов

  • Главная страница API - Запрос предназначен для предоставления информации об API, в том числе справочной информации, условиях использования и перечня возможных запросов.

    Структура запроса: «/api/<format>»

  • Перечень наборов открытых данных - запрос предназначен для получения перечня наборов открытых данных.

    Структура запроса: «/api/<format>/dataset»

  • Набор открытых данных - запрос предназначен для получения набора открытых данных.

    Структура запроса:«/api/<format>/dataset/<dataset>»

  • Перечень версий набора открытых данных - запрос предназначен для получения перечня версий набора открытых данных.

    Структура запроса: «/api/<format>/dataset/<dataset>/version»

  • Версия набора открытых данных - Запрос предназначен для получения полной информации о версии набора открытых данных.

    Структура запроса: «/api/<format>/dataset/<dataset>/version/<version>»

  • Структура версии набора открытых данных - Запрос предназначен для получения полной информации о структуре версии набора открытых данных.

    Структура запроса: «/api/<format>/dataset/<dataset>/version/<version>/structure»

  • Содержимое файла версии набора открытых данных - Запрос предназначен для получения содержимого файла версии набора открытых данных.

    Структура запроса: «/api/<format>/dataset/<dataset>/version/<version>/content»

  • Перечень организаций - Запрос предназначен для получения перечня зарегистрированных на портале организаций, предоставляющих открытые данные.

    Структура запроса: «/api/<format>/organization»

  • Организация - Запрос предназначен для получения полных данных организации, предоставляющей открытые данные.

    Структура запроса: «/api/<format>/organization/<organization>»

  • Перечень наборов открытых данных организации - Запрос предназначен для получения перечня наборов открытых данных.

    Структура запроса: «/api/<format>/organization/<organization>/dataset»

  • Перечень тематических рубрик - Запрос предназначен для получения перечня тематических рубрик наборов открытых данных.

    Структура запроса: «/api/<format>/topic»

  • Тематическая рубрика - Запрос предназначен для получения тематической рубрики.

    Структура запроса:< «/api/<format>/topic/<topic>»

  • Перечень наборов открытых данных по тематической рубрике - Запрос предназначен для получения перечня наборов открытых данных по тематической рубрике.

    Структура запроса: «/api/<format>/topic/<topic>/dataset»

Более подробную и детальную информацию вы можете найти в документации по API.