API администратора зала на локальном сервере (филиале) СУО Энтер⚓

Доступно в СУО версии 1.2.0.0 и выше

Отдельные методы могут иметь особые отметки о доступности с более поздних версий

Общие сведения⚓

API работает по протоколу HTTP на порту, сконфигурированом для службы локального сервера СУО (по умолчанию 80).

Запросы к API выполняются через HTTP-методы GET/POST.

Тело ответа имеет формат JSON, кодировку UTF-8.

Доступ к API возможен при соблюдении следующих условий:

Запрос выполняется с HTTP-заголовком Token, в котором указывается токен вашей системы, выданный вам администратором центрального сервера СУО. Если токен некорректный, сервер вернет ответ с HTTP-статусом 401 Unauthorized.
Внешней системе, Token которой указывается в заголовке, разрешено работать с данным API в настройках в разделе "Интеграция". Если такого разрешения нет, то сервер вернет ответ с HTTP-статусом 403 Forbidden.

Формат ответа об ошибке⚓

Ответ об ошибке приходит с HTTP-статусом 4xx или 5xx. В теле ответа приходит объект ErrorResponse.

Ответ с HTTP-статусом 4xx означает, что вероятно проблема на стороне интегратора, или клиента.
Ответ с HTTP-статусом 5xx означает, что проблема произошла не по вине клиента и не по вине интегратора, нужно обратится к владельцам системы с текстом ошибки.

Примечание

Если приходит UserMessage, то его обязательно нужно показать клиенту, если его нет, можно сказать общим планом, что что-то пошло не так.

Если приходит Message, значит интегратору нужно обратить на него внимание, если его нет, то никак не нужно реагировать

"ErrorResponse": {
    "UserMessage": "string", //Сообщение для пользователя
    "Message": "string" //Сообщение для интеграторов
}

Пример ответа на непринятый запрос⚓

  // POST /api/1/callcenter/login HTTP/1.1
  // Token: a0adba90-b8a7-4fcd-9f73-787ae2eed727
  // Content-Length: 0
  // Host: center.suo.club:82

  // HTTP/1.1 401 Unauthorized
  // Content-Length: 138
  // Content-Type: application/json; charset=utf-8
  // Server: Microsoft-HTTPAPI/2.0
  // Access-Control-Allow-Origin: *
  // Date: Fri, 07 Jun 2019 10:01:21 GMT

  {
    "UserMessage":null,
    "Message":"Внешняя система с токеном a0adba90-b8a7-4fcd-9f73-787ae2eed727 не найдена."
  }