Open API

PassOffice API представляет собой REST API, позволяющий выполнить интеграцию с сторонними системами для работы с заявками PassOffice (создание, получение статуса и аннулирование).

1. Запуск сервиса интеграции

Чтобы воспользоваться PassOffice API, необходимо запустить сервис интеграции, находящийся по пути:

[PassOffice]/{version}/bin/IntegrationServer.bat, предварительно задав в файле [PassOffice]/{version}/bin/config/integration-server.properties следующие настройки:

server.port=8080 # порт для PassOffice Open API
passoffice.url=http://localhost:4201 # адрес сервера PassOffice
passoffice.username=admin # логин для оператора интеграции
passoffice.password=admin # пароль для оператора интеграции

2. Документация API (Swagger)

После запуска службы PassOffice API руководствуйтесь Swagger документацией, доступной по адресу:

http://localhost:8080/swagger-ui/index.html

3. Настройка SSL

Для настройки SSL соединения с PassOffice API воспользуйтесь инструкцией и проделайте аналогичные шаги для настроек integration-server.properties.

4. Поиск встречающих при создании заявки

Для поиска встречающих при создании заявки используются ключевые поля, которые настраиваются в Корне системы в соответствии с тем, по каким полям нужен поиск.

Поиск можно настроить с помощью нескольких наборов полей, например, по фамилии, имени и отчеству или только по электронной почте. В таком случае в теле запроса на создание заявки необходимо передать объект с заданными полями для поиска.

Также поиск можно выполнить по идентификатору человека. Для этого в объекте встречающего достаточно передать только его идентификатор.

5. Значения по умолчанию (Группы доступа, Согласующие)

Для проставления значений по умолчанию, например, Групп доступа, Согласующих, при создании заявки необходимо использовать правила объектов с условием для поля "Заявка" и операцией "Объект создан".

Данное правило примените к настройкам внешнего вида оператора, под которым работает сервер интеграции.