Web Services

Last Updated: 09 Feb 2018

The Web Services package provides an infrastructure for external systems to communicate with the Squiz Matrix System using Simple Object Access Protocol (SOAP), Javascript and Representational State Transfer (REST) configurations. These set-ups allow the creation, modification and retrieval of system content through the use of application programming interfaces (APIs), each performing a distinct set of functions. The operations available on these APIs can be modified, allowing full control of the functionality available on the web service system.

The Javascript API and SOAP Server Web Services
The Javascript API and SOAP Server Web Services

The Web Services package also provides communication with external REST web services through REST Resource assets. These assets enable content to be retrieved and modified from authorised servers almost anywhere on the web.

The Web Services package consists of three major components:

  • SOAP Server: the SOAP Server asset provides the framework for Simple Object Access Protocol (SOAP) requests within the system, allowing the SOAP Server to create, modify and retrieve content using either a SOAP client or Frontend Javascript implementation via the SOAP Server’s Javascript API. These functions are handled by SOAP API Service assets, linked and managed under the SOAP Server. The SOAP API assets available are as follows:
    • Asset Service: this API provides asset functions, such as the creation and deletion of assets.
    • Design and Lookups Service: this API provides design functions, such as the application of Design and Paint Layout assets.
    • File Service: this API provides file functions, such as downloading and uploading files to the system.
    • Link Service: this API provides link functions, such as linking one asset to another.
    • Metadata Service: this API provides metadata functions, such as applying a Metadata Schema.
    • Permission And Role Service: this API provides permission and role functions, such as changing an asset’s permissions.
    • Search Service: this API provides search functions, such as making a search of system content.
    • Workflow Service: this API provides workflow functions, such as approving workflow.
  • Javascript API: the Javascript API provides a set of functions allowing AJAX requests to create, modify and retrieve content within Squiz Matrix. These functions are configured on the Details screen of the Javascript API asset, listed under the following sections:
    • Core: the core functions of the API, such as the creation and deletion of assets.
    • Linking: the linking functions of the API, such as moving and updating links.
    • Permissions: the permission functions of the API, such as retrieving permissions of an asset.
    • Traversing: the asset lineage functions of the API, such as retrieving parent and child asset information.
    • Metadata: the metadata functions of the API, such as applying a Metadata Schema.
  • REST Resource: the REST Resource asset provides the ability to communicate with web services that expose themselves using Representational State Transfer (REST). Additional REST assets are also available to provide further functions:
    • REST Resource JavaScript: generates HTTP Request data as JSON data, enabling the use of JavaScript processing.
    • REST Resource OAuth Session: provides authentication to OAuth secure REST web services.

The Latest

Let Us Know What You Think

Let us know if you spot any errors or if you have any ideas on how we can improve the Matrix Community Website.

Contact Squiz for Demo

Let us show you the true power of Squiz Matrix by giving you a personalised demonstration.