SOAP Web Services

Web services provide Cascade CMS users with a powerful way to work with the system by providing a powerful back-end interface with which to interact.

Background

Web services leverage the power of XML to communicate using SOAP (Simple Object Access Protocol). While most of the time one will use a framework that abstracts the logic away from writing the pure XML requests (such as a PHP SOAP client or Apache Axis), the common denominator are these SOAP messages in the XML format that must conform to the WSDL set forth by Cascade CMS.

For more information about the SOAP standard, please see: https://www.w3.org/TR/soap/

We also provide a version of our webservices API based on REST that used JSON.

The WSDL

WSDL is the Web Services Description Language, and it describes all the information that is valid for transmission in a SOAP request and response for a specific web services implementation. It is simply a standard XML file containing descriptive information about how everything in a SOAP request/response is related.

For more information about WSDL, see: https://www.w3.org/TR/wsdl

Web Services End Points

The Cascade CMS Asset Operation Endpoint

Most requests go through the Cascade CMS web services endpoint called the AssetOperationService. This Endpoint is responsible for create, read, edit, delete, publish, and batch operations.

You can find a copy of the WSDL for this Endpoint on your local instance at /ws/services/AssetOperationService?wsdl, for instance at http://cascade.mycompany.com:8080/ws/services/AssetOperationService?wsdl.

The Cascade CMS Security Endpoint

This endpoint is available to enable an external application to authenticate a user login for Cascade CMS. You can find a copy of the WSDL for this Endpoint on your local instance at /ws/services/SecurityService?wsdl, for instance at http://cascade.mycompany.com:8080/ws/services/SecurityService?wsdl.

Sample Web Services Projects

There is a sample Java project and sample PHP project in a Git repository on Hannon Hill's GitHub page to help users get started using the Cascade SOAP Web Services.

To use Git, download it from the website. If you a client installed already, repositories can be cloned using the Git url: git://github.com/hannonhill/Webservices-Java-Sample-Project.git from the GitHub project page, for example.

For users of:

Cascade 7.14.x - checkout the 7.14.x branch or download the source
Cascade 6.7.x - checkout the 6.7.x branch or download the source
Cascade 6.0.x-6.4.x - checkout the 6.0-6.4.x branch or download the source

The README explains how to get the sample project imported and built in Eclipse.