Назначение модуля API

НАЧАЛО >> API ИРБИС 64/128 >> Назначение модуля API📄 Скачать в DOCX

API предоставляет единый JSON-RPC сервер для интеграции внешних приложений с ИРБИС 128 и владеет реестром публичных API-контрактов. Модуль собирает в одной точке методы, которые внутри системы выполняются модулями Users, RQST, Bookland, EC и Database, и дает им стабильное metadata-описание.

Административные записи модуля API используются для API-контрактов, профилей внешней интеграции, mapping profiles, ExternalId, SyncPolicy и ConflictPolicy. Контракт фиксирует ключ, версию, статус публикации, методы, ресурсы, transport references, права, идемпотентность, Help и TestA. Профиль интеграции ссылается на контракт и задает внешнюю систему, направление обмена, transport profile, security subject и ссылки на Secrets. MappingProfile описывает сопоставление внешних полей, статусов, участников и файлов с системными контрактами ИРБИС 128. ExternalId связывает внешний идентификатор с внутренним object type и record reference. SyncPolicy и ConflictPolicy описывают dry-run sync, explainable diff и безопасный contract передачи изменений доменному модулю.

Основная точка подключения:

https://example.org/JSONRPC.php?i128Module=API

В адресе example.org нужно указать адрес сервера ИРБИС 128. Параметр i128Module=API выбирает JSON-RPC сервер модуля API.

1. Группы методов

Описание параметров и возвращаемых значений находится в разделе JSON-RPC API модуля API.

Описание contract registry, профилей интеграции, mapping, ExternalId и sync/conflict policies находится в разделах API-контракты, Профили внешней интеграции, Mapping и ExternalId и SyncPolicy и ConflictPolicy.