Как добавить REST или SOAP сервис на Сервере Безопасности

1. Подсистема(subsystem) зарегистрирована: статус registered.
2. Ваше приложение работает, API доступен с самого Security Server.
3. Для REST известны базовый URL, Service Code и нужные HTTP методы/пути.
4. Для SOAP опубликован корректный WSDL, доступный с Security Server.

Пример: ваша система работает по адресу http://10.10.10.10:8080/api/. Это внутренний адрес вашего приложения, а не адрес чужого Security Server.

1. Откройте CLIENTS → [ваша подсистема] → SERVICES.
2. Нажмите ADD REST.
3. Выберите тип описания:
   • REST API Base Path — укажите базовый URL API, например http://10.10.10.10:8080/api/.
   • OpenAPI 3 Description — укажите доступную ссылку на OpenAPI 3 описание, если оно существует и корректно.
4. Введите Service Code — короткий уникальный код сервиса в данной подсистеме, например citizen-info.
5. Нажмите ADD.
6. Разверните добавленное REST-описание и откройте сервис по его коду. Проверьте целевой URL, параметры подключения и timeout; сохраните изменения (SAVE).
7. В списке описаний включите добавленный сервис/описание (после добавления он по умолчанию выключен).

Обратите внимание: Для REST Base Path endpoint-ы можно добавить вручную: откройте сервис → ENDPOINTS → ADD ENDPOINTS, задайте HTTP-метод и путь. Для OpenAPI 3 endpoint-ы обычно загружаются из описания. Это важно, если нужно ограничивать доступ к отдельным путям.

1. Откройте CLIENTS → [ваша подсистема] → SERVICES.
2. Нажмите ADD WSDL.
3. Вставьте URL WSDL, например http://10.10.10.10:8080/ws/service?wsdl.
4. Нажмите ADD. Security Server прочитает WSDL и сформирует список методов.
5. Разверните WSDL и проверьте найденные Service Code и адреса методов.
6. Откройте нужный сервис, проверьте конечный URL, протокол и timeout; сохраните (SAVE).
7. Включите WSDL/описание сервиса: сразу после добавления оно обычно отключено.

Важно: для SOAP нельзя произвольно придумать имя метода, не соответствующее WSDL. При изменении WSDL используйте обновление описания (Refresh) и проверьте, что методы и адреса остались корректными.

Публикация не выдаёт права другому участнику. Перейдите к настройке доступа (ACL).

• Описание присутствует в SERVICES.
• Сервис enabled (включён), а не disabled.
• Внутренний URL доступен с Security Server.
• У нужного потребителя есть ACL на сервис (или на конкретный REST endpoint).
• Реальный тестовый запрос проходит через X-Road; прямой curl к вашему API проверяет только внутреннюю часть маршрута.

• WSDL не загружается — URL, DNS, firewall, TLS, некорректный XML.
• ServiceFailed / NetworkError — Security Server не может подключиться к приложению; проверьте URL, порт, сертификат и логи приложения.
• UnknownService — неверный код сервиса/подсистемы либо сервис не опубликован/недоступен; сравните идентификаторы.
• AccessDenied — сервис опубликован, но потребителю не разрешён вызов.

Источник: X-Road Security Server User Guide, главы 6–7, Тундук: предоставление REST сервисов.