Руководство пользователя#

API Jasper представляет из себя REST-сервис. Запросы в API Jasper могут быть вида GET, POST, PUT, PATCH, HEAD. При обращении к API Jasper на запросы возвращаются стандартные HTTP-ответы.

Обмен данными осуществляется в формате XML по утвержденным на стороне API Jasper XSD-схемам. При этом XML используется внешним интеграционным сервисом только при отправке запроса на выполнении XML-пакета в Системе. А сами сведения по запросам, содержащие информацию об объектах Системы и их состоянии, API Jasper отдает в формате JSON.

Функциональные возможности:

  1. Создание объектов в Системе.

  2. Поиск объектов и справочников в Системе по заданным критериям, в зависимости от имеющихся прав.

  3. Просмотр объектов Системы, в зависимости от имеющихся прав на конкретные типы.

  4. Загрузка файлов в Систему.

  5. Скачивание файлов из Системы.

  6. Валидация XML-пакета согласно утвержденной на стороне API Jasper XSD-схеме.

  7. Вызов обработки действий из Системы: отправка результата услуги по кнопке Отправить.

API позволяет интегрироваться с внешними системами и решать следующие задачи:

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

  • импортировать данные (создавать, изменять, удалять объекты) из других внешних систем;

  • экспортировать данные в другие внешние системы.

Важно

API Jasper не поддерживает работу напрямую с ЕПГУ и СМЭВ

Может использоваться для следующих сценариев:

  1. Получение списка доступных для интеграционного сервиса XSD-схем.

  2. Получение конкретной XSD-схемы, которая описывает структуру пакета, направляемого в запросе клиентом для выполнения поставленной бизнес-задачи.

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

  4. Поиск объектов и справочников в Системе по заданным критериям, в зависимости от имеющихся прав.

  5. Выполнение API XML-пакета, полученного в запросе от клиента.