Разработчикам

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

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

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

API предлагает JSON-формат вывода результатов запроса.

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

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

  1. Список наборов открытых данных и содержащихся в них объектов API
  2. Перечень наборов открытых данных
  3. Набор открытых данных
  4. Список тем
  5. Информация об объекте набора открытых данных
  6. Список файлов

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

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

  • Список наборов открытых данных и содержащихся в них объектов API - Запрос предназначен для получения список всех наборов открытых данных и содержащихся в них объектов

    Структура запроса: «/api/3/action/current_package_list_with_resources»

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

    Структура запроса: «api/3/action/package_list»

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

    Структура запроса:«/api/3/action/package_show?id=%id»

  • Список тем - запрос предназначен для получения списка всех тем.

    Структура запроса: «/api/3/action/group_list»

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

    Структура запроса: «/api/3/action/resource_show?id=%id»

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

    Структура запроса: «/data.json»