Difference between revisions of "Webservices Guide - OpenKM 6.2"

From OpenKM Documentation
Jump to: navigation, search
(→‎OpenKM 5.1 and olders)
 
(27 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
{{TOCright}} __TOC__
 +
 +
{{Note|If you're interested in use OpenKM API we suggest to '''take a look at ours [[SDK]]'s''' and take advantage of already usable libraries which connect to webservices API.}}
 +
 
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 [[Third-party system integration|integrate with third-party applications]] like a CRM or a CMS.
 
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 [[Third-party system integration|integrate with third-party applications]] like a CRM or a CMS.
 +
 +
{{Advice|OpenKM 6.2 WSDL follow '''document / literal''' style. To learn more visit [http://www.ibm.com/developerworks/webservices/library/ws-whichwsdl/ Which style of WSDL should I use?].}}
  
 
These are the WSDL available:
 
These are the WSDL available:
  
−
* http://localhost:8080/OpenKM/OKMAuth?wsdl
+
{{Note|In OpenKM 6.2 webservices are listed at http://localhost:8080/OpenKM/services.}}
−
* 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
 
  
−
{{Note|In the upcoming OpenKM 6.0 webservices will be 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'''
 
'''OKM Webservices API'''
 +
 +
{{Note|Since OpenKM Professional 6.2.23 and OpenKM Community 6.2.6 you can use MTOM. Read [[http://pic.dhe.ibm.com/infocenter/wasinfo/v7r0/index.jsp?topic=%2Fcom.ibm.websphere.express.doc%2Finfo%2Fexp%2Fae%2Ftwbs_enablemtom.html Enabling MTOM support in JAX-WS bindings]] for more info. See also [[Webservices Changelog]].}}
 +
 
* [[OKMAuth]]
 
* [[OKMAuth]]
 
* [[OKMBookmark]]
 
* [[OKMBookmark]]
Line 32: Line 41:
 
* [[OKMWorkflow]]
 
* [[OKMWorkflow]]
  
−
== OpenKM 5.1 and olders ==
+
{{Note|If you like Python, try the [https://github.com/tangentlabs/django-openkm 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'''
 
−
* [[XML client]]
 
−
* [[Java client]]
 
−
* [[Android client]]
 
−
* [[Python client]]
 
−
* [[PHP client]]
 
−
* [[C Sharp client 5.1|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:
 
  
−
<source lang="xml">
+
==Sample clients==
−
<property name="webServiceHost">your.company.com</property>
+
* [[Java client - OpenKM 6.2|Java client]]
−
<property name="webServicePort">80</property>
+
* [[PHP client - OpenKM 6.2|PHP client]]
−
<property name="modifySOAPAddress">true</property>
+
* [[C Sharp client - OpenKM 6.2|C# client]]
−
</source>
 
  
 
[[Category: Webservices Guide]]
 
[[Category: Webservices Guide]]

Latest revision as of 16:55, 26 November 2014


Nota clasica.png If you're interested in use OpenKM API we suggest to take a look at ours SDK's and take advantage of already usable libraries which connect to webservices API.

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.


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

These are the WSDL available:


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

OKM Webservices API


Nota clasica.png 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. See also Webservices Changelog.


Nota clasica.png 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

Retrieved from "https://www.openkm.com/wiki/index.php?title=Webservices_Guide_-_OpenKM_6.2&oldid=12085"