Using the Cascade Server Web Service API, by Artur Tomusiak
- 1. Cascade Server Web Services Artur Tomusiak Senior Software Developer
- 2. Introduction What's Ahead: • What is a web service? • Real life applications • Cascade Server Web Services Operations • Understanding the WSDL file • Code examples for most commonly used operations • What is coming in Cascade Server 7.2?
- 3. What is a web service? Web Service is a way to communicate between your own application and Cascade Server. Cascade Server uses SOAP for web services which uses XML format to send and receive information
- 4. Real life applications • Importing/exporting content • Handling form submissions • Updating access rights on multiple assets for a single user or group • Advanced bulk change • Bulk update content • Selective publishing of specific assets only • Data Definition Page to Data Definition Block conversion
- 5. Authentication Each operation needs to be authenticated using a username and password The operation is then executed as if that User performed the operation in the web UI: • Given User is the author of the operation • Permissions and abilities are verified • Audits are created for that User
- 6. Available operations http://yourcascadeinstance.com/ ws/services Most frequently used operations: • Create • Read • Edit • Delete • Copy • Read/Edit Access Rights • Publish
- 8. Important keywords in WSDL "complexType" and "simpleType"
- 9. Important keywords in WSDL "element" Attributes: "minOccurs", "maxOccurs" and "type" Comments
- 10. Important keywords in WSDL "extension"
- 11. Important keywords in WSDL "choice"
- 12. WSDL reading example Find necessary elements to create an XML Block
- 20. WSDL reading example Required: • xml • parentFolderId or parentFolderPath • name Optional: • expirationFolderId or expirationFolderPath • metadataSetId or metadataSetPath • Metadata fields (title, displayName, etc.) • siteId or siteName
- 21. PHP code examples Client and authentication
- 22. PHP code examples Create
- 23. PHP code examples Create
- 24. PHP code examples Read
- 25. PHP code examples Read
- 26. PHP code examples Read
- 27. PHP code examples Edit
- 28. PHP code examples Edit
- 29. PHP code examples Delete
- 30. PHP code examples Copy
- 31. PHP code examples Copy
- 32. PHP code examples Copy
- 33. PHP code examples ReadAccessRights
- 34. PHP code examples EditAccessRights
- 35. PHP code examples EditAccessRights
- 36. PHP code examples https://github.com/hannonhill/Webservices-PHP- Sample-Project Use correct branch Not always backwards compatible Follow "Web Services Changelog" for each version http://www.hannonhill.com/kb/Web- Services/Web%20Services%20Changelog/index.html
- 37. Limitations • Can’t access past versions of assets and drafts • Can’t render assets • Can’t use tools • Can’t change preferences • Can’t change configuration files • Can’t view or interact with publish queue • Certain operations can be limited
- 38. What is coming in Cascade 7.2 • ListAllSites • ReadWorkflowSettings • EditWorkflowSettings • ListSubscribers • Providing Destinations when publishing • “Maintain absolute links” for Pages
- 39. Questions
- 40. Thank you Artur Tomusiak [email protected]