API управляющего сервера

API управляющего сервера позволяет интегрировать его со сторонними информационными системами.

Обращение к API серверу производится по протоколу HTTPS POST на указанный для каждого конкретного метода URL.

URL каждого метода имеет вид:

​https://<ip-адрес управляющего сервера>/api/<имя метода>

При запросе сторонний сервер передаёт управляющему серверу в POST-запросе (content-data) XML-документ. Управляющий сервер возвращает результирующий XML-документ или код ошибки (HTTP-код).

При формировании запроса также необходимо указывать логин и пароль в формате http-авторизации.

Метод importpassidregister : импорт справочника пропусков

Формат запроса:

https://<ip-адрес управляющего сервера>/api/importpassidregister?id=<id справочника>&mode=<режим обработки>

GET-параметры запроса:

• id - идентификатор справочника
• mode - режим обработки: rewrite - полная перезапись, append - добавление

Управляющий сервер принимает POST-запрос вида:

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <item pass_id="123" pass_type="1" name="Петров Иван Иванович"/>
  <item pass_id="333" pass_type="1" name="Иванов Иван Иванович"/>
</root>

Где:

• /root/item - одна добавляемая запись
• /root/item/@pass_id - идентификатор
• /root/item/@pass_type - тип идентификатора
• /root/item/@name - наименование, ассоциированное с записью

Управляющий сервер возвращает код 200, если записи успешно добавлены, или иной в случае ошибки.