Difference between revisions of "Webservices Guide - OpenKM 6.2"

From OpenKM Documentation
Jump to: navigation, search
 
(48 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
OpenKM has a complete API exposed via Webservices. This means you can call any of this API method from any programming language which supports SOAP protocol, like Java, PHP or Python between others. This feature make possible to create a custom client, or integrate with third party applications like a CRM or a CMS.
+
{{TOCright}} __TOC__
  
−
These are the WSLD available:
+
{{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.}}
  
−
* http://localhost:8080/OpenKM/OKMAuth?wsdl
+
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.
−
* http://localhost:8080/OpenKM/OKMDocument?wsdl
+
 
−
* http://localhost:8080/OpenKM/OKMFolder?wsdl
+
{{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?].}}
−
* http://localhost:8080/OpenKM/OKMRepository?wsdl
+
 
−
* http://localhost:8080/OpenKM/OKMSearch?wsdl
+
These are the WSDL available:
−
* http://localhost:8080/OpenKM/OKMNotification?wsdl
+
 
 +
{{Note|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'''
 
'''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]]
 
* [[OKMDocument]]
 
* [[OKMDocument]]
 
* [[OKMFolder]]
 
* [[OKMFolder]]
−
* [[OKMSearch]]
+
* [[OKMMail]]
 +
* [[OKMNote]]
 
* [[OKMNotification]]
 
* [[OKMNotification]]
 +
* [[OKMProperty]]
 +
* [[OKMPropertyGroup]]
 
* [[OKMRepository]]
 
* [[OKMRepository]]
 +
* [[OKMSearch]]
 +
* [[OKMWorkflow]]
  
−
'''Sample clients'''
+
{{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.''}}
−
* [[XML client]] [[File:Padlock.gif]]
 
−
* [[Java client]] [[File:Padlock.gif]]
 
−
* [[Python client]] [[File:Padlock.gif]]
 
−
* [[PHP client]] [[File:Padlock.gif]]
 
−
 
 
−
 
 
−
'''Generating C# Webservices in Windows'''
 
−
 
 
−
.Net framework comes with wsdl.exe utility ( possible it's not in your default path)
 
−
 
 
−
wsdl.exe http://localhost:8080/OpenKM/OKMAuth?wsdl /out:OKMAuthService.cs
 
−
 
 
−
 
 
−
Pay attention in public OKMAuthService class, it'll be generated some OKMAuthService() constructor that you would like to change to take advantatge of host variable
 
−
 
 
−
 
 
−
public OKMAuthService() {
 
−
    this.Url = http://127.0.0.1:8080/OpenKM/OKMAuth;
 
−
}
 
−
 
−
change to
 
−
 
−
public OKMAuthService(String host) {
 
−
    this.Url = host;
 
−
}
 
−
 
 
  
 +
==Sample clients==
 +
* [[Java client - OpenKM 6.2|Java client]]
 +
* [[PHP client - OpenKM 6.2|PHP client]]
 +
* [[C Sharp client - OpenKM 6.2|C# client]]
  
 
[[Category: Webservices Guide]]
 
[[Category: Webservices Guide]]

Latest revision as of 17: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"