Difference between revisions of "Webservices Guide - OpenKM 6.2"

Revision as of 14:14, 17 March 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.

These are the WSDL available:

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

OpenKM 6.2

• 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

OpenKM 5.1 (and older)

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

OKM Webservices API

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

Sample clients

OpenKM 6.2

• Java client
• PHP client
• C# client

OpenKM 5.1 and older

Sample clients

• XML client
• Java client
• Android client
• Python client
• PHP client
• C# client
• Ruby client

Changing of soap:address location

By default, JBoss set the soap:address to the bind address. Usually this cause problems because the SOAP client will try to connect to a incorrect address. To change this, edit the file $JBOSS_HOME/server/default/deploy/jbossws.sar/jbossws.beans/META-INF/jboss-beans.xml and take a look a these values:

<property name="webServiceHost">your.company.com</property>
<property name="webServicePort">80</property>
<property name="modifySOAPAddress">true</property>