Difference between revisions of "Webservices Guide - OpenKM 6.2"

Revision as of 10:17, 11 November 2013

OpenKM has a complete API exposed via Webservices. This means you can call any of these API methods from any programming language which supports the SOAP protocol, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

OpenKM 6.2 WSDL follow document / literal style. To learn more visit Which style of WSDL should I use?.

These are the WSDL available:

In OpenKM 6.2 webservices are listed at http://localhost:8080/OpenKM/services.

• http://localhost:8080/OpenKM/services/OKMAuth?wsdl
• http://localhost:8080/OpenKM/services/OKMBookmark?wsdl
• http://localhost:8080/OpenKM/services/OKMDocument?wsdl
• http://localhost:8080/OpenKM/services/OKMFolder?wsdl
• http://localhost:8080/OpenKM/services/OKMMail?wsdl
• http://localhost:8080/OpenKM/services/OKMNote?wsdl
• http://localhost:8080/OpenKM/services/OKMNotification?wsdl
• http://localhost:8080/OpenKM/services/OKMProperty?wsdl
• http://localhost:8080/OpenKM/services/OKMPropertyGroup?wsdl
• http://localhost:8080/OpenKM/services/OKMRepository?wsdl
• http://localhost:8080/OpenKM/services/OKMSearch?wsdl
• http://localhost:8080/OpenKM/services/OKMWorkflow?wsdl

OKM Webservices API

Since OpenKM Professional 6.2.23 and OpenKM Community 6.2.6 you can use MTOM. Read [Enabling MTOM support in JAX-WS bindings] for more info.

• OKMAuth
• OKMBookmark
• OKMDocument
• OKMFolder
• OKMMail
• OKMNote
• OKMNotification
• OKMProperty
• OKMPropertyGroup
• OKMRepository
• OKMSearch
• OKMWorkflow

If you like Python, try the django-openkm project: A Python/Django client library for interaction with the OpenKM web services API. Integrates into the Django admin. OpenKM is an open-source, Java document management system with Lucene search built-in.

Sample clients

• Java client
• PHP client
• C# client