API Jasper#

Администрирование всей работы с API осуществляется в конфигураторе API Jasper. API Jasper предназначен для организации взаимодействия с внешними информационными системами без доработки платформы Geometa. Используя API Jasper, сторонние разработчики могут самостоятельно интегрировать свои системы с Geometa или создавать новые приложения.

API Jasper может взаимодействовать с любыми системами, которым нужно получать или передавать данные, и позволяет решать следующие задачи:

  • взаимодействие с порталами услуг для оказания государственных и муниципальных услуг в электронном виде (ЕПГУ/РПГУ);

  • импорт данных из внешних информационных систем в структуру модели данных основной Системы. Например, загрузка заявлений из системы электронного документооборота;

  • экспорт данных, представленных в структуре модели данных основной Системы, во внешние информационные системы. Например, передача сведений об итогах предоставления услуги.

Важно

С внешними системами API Jasper всегда работает через посредника. Прослойкой между API Jasper и внешней системой, как правило, выступает интеграционный сервис.

Взаимодействие с API Jasper требует регистрации внешних интеграционных систем в качестве клиентов API. Всем клиентам задаются права доступа к объектам определённых типов, которые они могут получать, создавать или редактировать в Системе.

Запрос и передача данных внешним интеграционным сервисом в API Jasper Системы осуществляется в формате .xml по утверждённым на стороне API xsd-схемам. Ответ на запрос, содержащий информацию об объектах Cистемы и их состоянии, API Jasper возвращает в формате .json.

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

  • получение информации об имеющихся правах доступа на объекты определенных типов Системы у зарегистрированной внешней интеграционной системы;

  • получение списка проектов, с объектами которых доступно взаимодействие внешней интеграционной системе;

  • получение xsd-схем, доступных для работы с объектами Системы;

  • валидация xml-запроса согласно xsd-схеме, утвержденной на стороне API Jasper;

  • поиск объектов в Системе по заданным критериям;

  • получение объектов из Системы с учётом имеющихся прав доступа;

  • создание объектов в Системе;

  • импорт файлов в Систему;

  • экспорт файлов из Системы;

  • подписка или отмена подписки на результат выполнения бизнес-процесса в Системе;

  • передача информации о пространственных объектах в API Jasper в формате .geojson;

  • запрос пространственной информации об объектах Системы в формате .geojson.

Запросы в API Jasper могут быть следующих видов:

  • GET – получение данных;

  • POST – создание объекта;

  • PUT – обновление данных;

  • PATCH – частичное изменение данных;

  • HEAD – частичное получение данных;

  • DELETE – удаление объектов.

Также API Jasper может использоваться для следующих сценариев:

  • получение списка доступных для интеграционного сервиса xsd-схем;

  • получение конкретной xsd-схемы, которая описывает структуру пакета, направляемого в запросе клиентом для выполнения поставленной бизнес-задачи;

  • получение списка доступных схем проекта, на которых развернута интеграция;

  • поиск объектов и справочников в Системе по заданным критериям в зависимости от имеющихся прав;

  • выполнение API Jasper xml-пакета, полученного в запросе от клиента.

API Jasper реализован в двух версиях: v1 и v2.

Версия указывается в запросе, например:

https://jasper-marvel-isogd.gemsdev.ru/api/v1/register/{schemeId}/{entityKey}

где:

  • v1 – номер версии.