Служба web-service осуществляет обмен данными с внешними ресурсами, т.е. принимает запросы на указанном порту, и отправляет запросы, если настроены регулярные платежи. Может использоваться для интеграции с web-сайтом и мобильными приложениями с помощью RESTful API и Mobile API, для интеграции с телефонией Mango Office и UIS и многим другим.
Установите службу, задайте необходимые настройки и запустите службу.
¶ Протоколы и порты
Выберите протокол соединения http или https. Хост указывается если на сервере используются несколько сетевых карт. Можно не указывать, тогда входящие соединения будут приниматься на всех интерфейсах. Порт указывать обязательно. ВНИМАНИЕ! Это любой свободный порт, но не порт 5432, на котором работает СУБД. Желательно НЕ стандартные 80 и 443.
Чтобы принимать входящие соединения на указанном порту - у вашего сервера должен быть публичный (белый) IP-адрес, либо используется проброс портов на роутере1.
¶ HTTPS
Рекомендуется использовать протокол https, т.к. протокол http может скомпрометировать безопасность.
Для приёма входящих HTTPS-соединений администратор должен получить и установить в систему действующий SSL-сертификат, которому доверяют браузеры и внешние сервисы (самоподписанный или просроченный сертификат для части интеграций не подойдёт — например, вебхуки Game Lead принимаются только по HTTPS с проверяемым сертификатом).
Способы получить доверенный сертификат:
- Встроенный генератор в «Настройке служб» или OpenSSL — быстрый вариант для внутреннего использования; для обращений из интернета часто недостаточно.
- Платный центр сертификации или бесплатно через certbot.
- Caddy (Windows) — reverse proxy: сам получает и продлевает сертификат Let's Encrypt, принимает HTTPS на порту 443 и передаёт запросы в web-service по HTTP на локальном порту (удобно, если не хотите настраивать сертификат напрямую в службе).
При прямом HTTPS в web-service сертификат указывается в настройках службы и состоит из двух файлов (*.key и *.cert).
В поле «Интервал отправки запросов» указывается интервал отправки регулярных платежей в минутах, не рекомендуется устанавливать маленькие значения, раз в 60 минут должно быть достаточно для нормальной работы платежей.
¶ Пути
Путь до API указывается в одном из форматов (подставьте IP-адрес или имя сервера и порт службы web-service вместо ip и порт):
http://ip:порт/api/v2/
https://ip:порт/api/v2/
Конкретный вариант зависит от выбранного протокола соединения: http или https.
Путь до Mobile API — аналогично:
http://ip:порт/api/mobifitness
https://ip:порт/api/mobifitness
¶ Сбор логов
Запустите настройку служб, на вкладке web-service установите опцию Логировать все http-запросы в файл. Сохраните и перезапустите службу.
Альтернативный вариант - запуск службы с ключами напрямую из файла.
Остановите службу web-service и запустите в командной строке с ключами: "web-service.exe -e -log", либо создайте ярлык. Вывод идет в файл C:\Users\имя пользователя\clubis-logs\web-service\clubis-web-service--дата--номер.log
Чтобы открыть домашнюю папку пользователя, введите в строку проводника %userprofile%.
Служба всегда должна быть запущена в единственном экземпляре! Остановлена как служба и запущена в отладке.
