API для взаимодействия
с внешними системами

Описание модуля

Модуль API обеспечивает возможность осуществления запросов и передачи данных внешним интеграционным сервисам в формате XML, по утвержденным на стороне API XSD-схемам. Ответ на запрос, содержащий информацию об объектах Системы и их состоянии, API возвращает в формате JSON. Взаимодействие с API требует регистрации внешних интеграционных систем в качестве клиентов API. Всем клиентам задаются права доступа на объекты определенных типов, которые они должны иметь возможность получать, создавать или редактировать в Системе. API предоставляет следующие функциональные возможности: • получение информации об имеющихся правах доступа на объекты определенных типов Системы у зарегистрированной внешней интеграционной системы; • получение проектов, с объектами которых доступно взаимодействие внешней интеграционной системы; • получение XSD-схемы/списка XSD-схем, доступных для работы с объектами Системы; • валидация XML запроса, согласно утвержденной на стороне API XSD-схеме; • просмотр объектов Системы с учетом имеющихся прав доступа; • создание объектов в Системе; • редактирование объектов Системы; • поиск объектов в Системе по заданным критериям; • выгрузка файлов из Системы; • загрузка файлов в Систему; • подписка/отмена подписки на результат выполнения бизнес-процесса в Системе; • передача информации о пространственных объектах Системы в API в формате GeoJSON; • получение информации о пространственных объектах внешних систем в API в формате GeoJSON. Ознакомьтесь с документацией.