Интеграция по REST API

Продукты Юниверс используют REST API для обмена данными между модулями внутри системы, а также для взаимодействия между продуктами (например, Юниверс MDM и DG) и сторонними системами.

REST API повторяет функциональность, доступную в пользовательском интерфейсе. Многие запросы к данным опираются на структуру модели данных, модели качества данных и т.д. Например, при создании записи атрибуты заполняются согласно модели данных и учитываются свойства атрибутов, указанные в модели.

Поэтому перед началом работы с REST API в системах Юниверс MDM и DG необходимо создать модель данных, состоящую из нескольких частей. Получить примеры описаний моделей можно, создав тестовые варианты в интерфейсе пользователя и экспортировав их в виде xml-файлов.

Примечание

При дальнейшем импорте файлов в систему необходимо учитывать, что файл model.xml (модель данных) должен импортироваться после файлов перечислений и единиц измерения, но до файлов модели качества данных и модели сопоставления.

Работа со Swagger

Основная документация по работе с REST API содержится в Swagger: перечень запросов, описание параметров и т.п.

Примечание

REST-сервисы доступны в установленном инстансе продукта через Swagger по ссылке http://<хост>:<порт>/universe-backend/api. Например, http://localhost:8081/universe-backend/api или http://universe-service/universe-backend/api.

Перечень стандартных REST-сервисов

REST API содержит набор сервисов, разделенных на публичные и непубличные. REST-сервисы разделены по функциям и соответствуют системным модулям.

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

Непубличные сервисы не имеют гарантии обратной совместимости, но они версионируются. Применение непубличных сервисов возможно только под ответственность пользователя. Могут быть изменены, переименованы или удалены без предварительного уведомления.

Публичные сервисы:

meta-data-driven - REST-сервис модуля com.universe.mdm.rest.v1.metadriven;
notifications - сервис нотификаций во внешние системы org.unidata.mdm.rest.v2.data;

Внутренние непубличные сервисы:

data - REST-сервис модуля работы с данными org.unidata.mdm.rest.v2.data;
draft - REST-сервис модуля черновиков org.unidata.mdm.rest.v2.draft;
matching - REST-сервис модуля механизма сопоставления org.unidata.mdm.rest.v2.matching.core;
classifiers - REST-сервис модуля классификаторов com.unidata.mdm.rest.v1.classifiers;
commercial-core - REST-сервис коммерческого модуля com.universe.mdm.rest.v1.core;
data - REST-сервис модуля сервисов проверки качества данных записей org.unidata.mdm.rest.v2.dq.data;
license - REST-сервис модуля лицензии com.unidata.mdm.rest.v1.license;
search - REST-сервис модуля поиска данных org.unidata.mdm.rest.v2.search;
marks - REST-сервис модуля маркирования объектов org.universe.mdm.rest.v1.marks;
core - REST-сервис модуля общих системных сервисов org.unidata.mdm.rest.v2.core;
workflow - REST-сервис модуля управления бизнес-процессами com.unidata.mdm.rest.v2.workflow.core;
ldap - REST-сервис модуля интеграции LDAP com.universe.mdm.rest.v1.ldap.integration;
data-quality - REST-сервис модуля качества данных org.unidata.mdm.rest.v2.dq.core;
bulk-operations - REST-сервис модуля пользовательских пакетных операций org.unidata.mdm.rest.v2.bulk.core;
matching-data - REST-сервис модуля сегментов результата сопоставления org.unidata.mdm.rest.v2.matching.data;
meta - REST-сервис модуля работы с моделью данных org.unidata.mdm.rest.v2.meta;