View Source

h2. Overview
{excerpt} The web services of the KIM Application Programming Interface (API) represent an interoperability layer for accessing the server functionality.{excerpt} They allow web access and language-independence. KIM users have successfully implemented clients in C#, Perl, Ruby and, of course, Java. All other languages with stable and mature [SOAP|Glossary#_Simple Object Access Protocol (SOAP)] implementation also work well.

The web service API consists of five services:

* Semantic Repository API web service -- for querying and modifying the underlying semantic repository.
* Document Repository API web service -- for querying, retrieving and modifying the stored documents. Support for CORE queries is provided as well.
* Semantic Annotation API web service -- for annotating documents
* Entity API web service -- contains methods that serve as an abstraction layer over the semantic repository and allow direct manipulations with entities.
* Query API web service -- contains methods that serve as an abstraction layer over the semantic and document repositories and allow combined queries.

The web services are packaged and ready for deployment on a [servlet container|http://www.wikipedia.com/wiki/Java_Servlet#Servlet_containers] like [Apache Tomcat 6.x|http://tomcat.apache.org] .

The web services are designed to be compliant to the [SOAP 1.2|http://www.w3.org/TR/soap12-part1/] standard. They also conform to the [WS-IBasic Profile 1.0|http://www.wikipedia.com/wiki/WS-I_Basic_Profile] specification. This is the only specification supported by the Microsoft.NET framework 1.1 and is a must for satisfactory interoperability with such clients. The web services are developed with [Apache Axis 1.4|http://ws.apache.org/axis], which is certified by the W3C web service implementation.

By default, the web services expect that the KIM Server is running on localhost:1099. See the [configuration instructions|_Web Service API Configuration] for details.