Skip to main content

SOM APIs

SOAP interfaces​

Two SOAP interfaces are included in the installation of the SOM Module. Please find a detailed description of the SOAP interfaces and of their functions in the Java documentation (javadoc) in HTML format.

  • Windows

    C:\Program Files\KOBIL\SSMS\modules\som\doc

  • Linux/Solaris

    /opt/KOBIL/SSMS/modules/som/doc

The documentation is divided into management and services; consequently, into two different directories:

SomManagementWs​

One SOAP interface is on the management node (SomManagementWs).

The URL with the standard installation is:

 https:// <FQHN  or IP-address>:8443/ssms-gui/soap/mgt/som/SomManagementWs

The Management SOAP interface is used to integrate the management tasks concerning the different devices and users with the systems of the IT environment.

Download the javadocs for SomManagementWs here: SomManagementWs

SomServicesWs​

The second SOAP interface is on the services node (SomServicesWs). This interface is used for the integration into applications that communicate and interact with the devices.

The URL with the standard installation is:

 https:// <FQHN or IP-address>:8445/ssms-services/soap/svc/som/SomServicesWs

Download the javadocs for SomServicesWs here: SomServicesWs

Use these interfaces only within a secured environment. As, via the SOAP interfaces, sensitive information like configuration changes and validity verification of devices and users are carried out, it is important for security reasons that these interfaces are accessed in an environment isolated from the internet.

Roles and permissions​

The use of the Management SOAP interfaces is controlled by roles, which define the permissions of every operator. The Services SOAP interface is authenticated by SSL and does not need any other authentication of the operator. For the Management SOAP interface, the roles or the operators are Super Administrator, Administrator, Help desk and Reviewer.