SOAP server

The SOAP server asset is used to enable the execution of core-level Matrix functions over the Simple Object Access Protocol (SOAP), allowing third-party applications to create, modify and retrieve content within the system. These functions are handled by API assets, linked and managed under the SOAP server, providing a distinct set of Matrix functionality.

The web services folder

To add a SOAP server, go to Add  Web services  SOAP server.

For a SOAP server to work, it must be created under the Web services folder, as shown in the figure.

An enabled SOAP server should also be live and have the appropriate permission levels set.

You can configure the settings of the SOAP server on its associated asset screens. The majority of these screens are similar to a standard page. They are described in the Asset screens documentation.

This documentation will describe the Details screen, which is different for a SOAP server.

HTTP authentication

Matrix’s SOAP server uses HTTP basic authentication to communicate with external systems. You must specify a valid username and password to access the SOAP server, as shown in the following diagram.

Matrix users should have read access to utilize the operations on the SOAP server.
HTTP authentication on the SOAP server

Read the HTTP authentication with PHP documentation for more information on HTTP authentication.

Details screen

The Details screen allows you to select the SOAP API asset service assets on the SOAP server.

Read the Asset screens documentation for more information about the Status, Future status, Thumbnail, and Details sections.

API

API assets

This section allows you to select the APIs available on the SOAP server and manage the server’s WSDL. For the fields in this section to be available, API assets must be created as children of the SOAP server, as shown in the figure.

The fields available in this section are as follows:

APIs available to this service

Select an API to make it available for use on the SOAP server. If enable is selected for an API asset, the functions selected on the API asset’s Details screen will be available on the SOAP server.

Namespace

Define a static namespace to be used in the SOAP server’s response.

Regenerate WSDL

Select this field to regenerate the SOAP server’s WSDL to reflect any new changes made to the server, such as an enabled API asset. The WSDL for the SOAP server displays the operation parameters available for the functions enabled on the SOAP server. The WSDL of a SOAP server can be viewed by appending ?WSDL to the URL of the server. For example:

http://system_root_url/_web_services/SOAP-server?WSDL
If you plan to run SOAP functions over a secure connection (HTTPS://), you will need to generate the SOAP WSDL file over HTTPS; otherwise the WSDL file will be incompatible with your SOAP function calls.

© 2015- Squiz Pty Ltd