Difference between revisions of "Web Services"

From LogicalDOC Community Wiki
Jump to navigationJump to search
(PHP Integration)
(Introduction)
 
(30 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
<div style="border: 1px solid rgb(170, 170, 170); padding: 0.4em; background-color: rgb(238, 238, 238); font-size: 150%;">
 +
'''LogicalDOC''' Web Services API
 +
</div>
 +
 
== Introduction  ==
 
== Introduction  ==
  
 
LogicalDOC can be used as middleware and can be integrated with other system by the use of the built-in Web Service.  
 
LogicalDOC can be used as middleware and can be integrated with other system by the use of the built-in Web Service.  
  
The Web Service module is part of the LogicalDOC core distribution and is compliant with W3C specifications SOAP and MTOM. Using SOAP over HTTP allows for easier communication through proxies and firewalls than previous remote execution technology. MTOM is a method of efficiently sending binary data to and from web services; it allows more efficient sending of binary data in a SOAP request or response.<br><br>The layer of [[Web Services Reference|'''Web-Service of LogicalDOC''']] is implemented using the framework [http://cxf.apache.org/ Apache CXF] (AKA XFire 2) version 2.2.x. <br>CXF implements the JAX-WS specifications, this makes the Web-Services of LogicalDOC extremely compatibles and adhering to the W3C's SOAP and MTOM standards. <br>Also allows to enable/disable the MTOM&nbsp;features, reducing lines of code needed to implement and deliver the web-services functionalities and increasing the maintainability of the program.<br><br>The [[Web Services Reference|'''LogicalDOC Web Services''']] are divided in 5 entities, each of them contains services of the same topic.<br>
+
The Web Service module is part of the LogicalDOC core distribution and is compliant with W3C specifications SOAP and MTOM. Using SOAP over HTTP allows for easier communication through proxies and firewalls than previous remote execution technology. MTOM is a method of efficiently sending binary data to and from web services; it allows more efficient sending of binary data in a SOAP request or response.<br><br>The web services layer is implemented using the framework [http://cxf.apache.org/ Apache CXF] (AKA XFire 2) version 2.5.x. <br>CXF implements the JAX-WS specifications, this makes the Web-Services of LogicalDOC extremely compatibles and adhering to the W3C's SOAP and MTOM standards. <br>Also allows to enable/disable the MTOM&nbsp;features, reducing lines of code needed to implement and deliver the web-services functionalities and increasing the maintainability of the program.<br>
 
 
== Web Services Reference  ==
 
 
 
The complete [[Web_Services_Reference|'''Web-Service Reference''' is available on this wiki.]]
 
 
 
== JAVA Examples  ==
 
 
 
On SourceForge we have released an example project that Tests the WS features of LD and simultaneously shows the WS invocations with JAVA<br>
 
 
 
{| cellspacing="1" cellpadding="1" border="1" style="width: 407px; height: 117px;"
 
|-
 
| align="center" | '''LogicalDOC version'''
 
| align="center" | '''Sample'''
 
|-
 
| 6.0
 
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.0/Java-webserviceTests-6.0.zip/download Java-WebServicesTests-6.0.zip]
 
|-
 
| 5.0/5.1
 
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.1/Java-webserviceTests-5.1.zip/download Java-WebServicesTests-5.1.zip]
 
|-
 
| 4.5
 
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-4.5/Java-webserviceTests-4.5.zip/download Java-WebServicesTests-4.5.zip<br>]
 
|-
 
| 4.0
 
| [http://sourceforge.net/project/downloading.php?group_id=239244&filename=logicaldoc-4.0-Java-WebServicesTests.zip&a=89909393 Java-WebServicesTests-4.0.zip]
 
|}
 
 
 
== .NET Integration  ==
 
 
 
This is a sample Visual Studio 2008 project created to illustrate some C# .NET 2.0 invocations of the LogicalDOC web-services<br>
 
 
 
{| cellspacing="1" cellpadding="1" border="1" style="width: 508px; height: 102px;"
 
|-
 
| align="center" | '''LD&nbsp;version'''
 
| align="center" | '''Sample package'''
 
|-
 
| 6.0
 
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.0/dotNET2WSClient-6.0.zip/download dotNET2WSClient-6.0.zip]<br>
 
|-
 
| 5.2.1
 
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.2/dotNET2WSClient-5.2.1.zip/download dotNET2WSClient-5.2.1.zip]<br>
 
|-
 
| 5.0
 
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.0/dotNET2WSClient-5.0.zip/download dotNET2WSClient-5.0.zip]<br>
 
|}
 
  
== PHP Integration  ==
+
== Web Services Documentation ==
  
The Web-Services of LogicalDOC are fully compatibles with PHP 5.2.x. <br>A few days ago we released a set of example that shows the invocation of methods through the SoapClient (SOAP extension) for PHP.<br>As always you can download it from SourceForge.<br>  
+
The complete Web Service reference is available at http://docs.logicaldoc.com/en/web-services-api.<br/>
  
{| cellspacing="1" cellpadding="1" border="1" style="width: 466px; height: 79px;"
+
== Web Services Bindings and Samples  ==
|-
 
| align="center" | '''LD version'''
 
| align="center" | '''Download Url'''
 
|-
 
| 6.0<br>
 
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.0/PHP-SOAP_webservice-6.0.zip/download PHP-SOAP_webservice-6.0.zip]<br>
 
|-
 
| 5.0/5.1<br>
 
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.1/PHP-SOAP_webservice-5.1.zip/download PHP-SOAP_webservice-5.1.zip]<br>
 
|-
 
| 4.5<br>
 
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-4.5/PHP-SOAP_webservice-4.5.zip/download PHP-SOAP_webservice-4.5.zip]<br>
 
|-
 
| 4.0
 
| [http://sourceforge.net/project/showfiles.php?group_id=239244&package_id=294971&release_id=667588 PHP-SOAP_webservice_examples.zip]
 
|}
 
  
<br>
+
The easiest way to interface with LogicalDOC's API's is by using one of our [[Bindings_And_Samples|'''Bindings and Samples''']].
 +
In this section are made available projects in all major programming languages​​: .Net, PHP and Java, complete with source code.
 +
They can be a good example to quickly learn "hands on" how to interface with the LogicalDOC's API

Latest revision as of 06:38, 30 August 2016

LogicalDOC Web Services API

Introduction

LogicalDOC can be used as middleware and can be integrated with other system by the use of the built-in Web Service.

The Web Service module is part of the LogicalDOC core distribution and is compliant with W3C specifications SOAP and MTOM. Using SOAP over HTTP allows for easier communication through proxies and firewalls than previous remote execution technology. MTOM is a method of efficiently sending binary data to and from web services; it allows more efficient sending of binary data in a SOAP request or response.

The web services layer is implemented using the framework Apache CXF (AKA XFire 2) version 2.5.x.
CXF implements the JAX-WS specifications, this makes the Web-Services of LogicalDOC extremely compatibles and adhering to the W3C's SOAP and MTOM standards.
Also allows to enable/disable the MTOM features, reducing lines of code needed to implement and deliver the web-services functionalities and increasing the maintainability of the program.

Web Services Documentation

The complete Web Service reference is available at http://docs.logicaldoc.com/en/web-services-api.

Web Services Bindings and Samples

The easiest way to interface with LogicalDOC's API's is by using one of our Bindings and Samples. In this section are made available projects in all major programming languages​​: .Net, PHP and Java, complete with source code. They can be a good example to quickly learn "hands on" how to interface with the LogicalDOC's API