Difference between revisions of "RESTful Guide"

Revision as of 10:09, 30 July 2013

OpenKM has a complete API exposed via REST. This means you can call any of these API methods from any programming language, 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.

For now this API is only available on OpenKM Professiona 6.4.2. This API is in development, so expect changes.

If you point your browser to http://localhost:8080/OpenKM/services, you can see the SOAP API at first place but at the bottom you will see a Available RESTful services section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

Sample use

To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the curl command-line application. For example, you can list the children folders:

 $  curl -u okmAdmin:admin -H "Accept: application/json" http://localhost:8080/OpenKM/services/rest/folder/getChildren/3492d662-b58e-417c-85b6-930ad0c6c3cf

The result is:

{"folderList":
  {"folder":
    [
      {"author":"okmAdmin", "created":"2013-07-29T12:09:11+02:00", "path":"\/okm:root\/alfa", "permissions":15, "subscribed":false, "uuid":"6b3e0531-96a9-4675-bb82-215b715b20ca", "hasChildren":false},
      {"author":"okmAdmin", "created":"2013-07-24T22:56:20+02:00", "path":"\/okm:root\/beta", "permissions":15, "subscribed":false, "uuid":"41f1bace-58b4-41a9-b43e-dffc1ac9a954", "hasChildren":false}
    ]
  }
}

In this case you can see the result in JSON format. Otherwise you can need an XML output, which can be forced using the 'Accept header:

 $ url -u okmAdmin:admin -H "Accept: application/xml" http://localhost:8080/OpenKM/services/rest/folder/getChildren/3492d662-b58e-417c-85b6-930ad0c6c3cf

The result in XML is:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<folderList>
  <folder>
    <author>okmAdmin</author>
    <created>2013-07-29T12:09:11+02:00</created>
    <path>/okm:root/alfa</path>
    <permissions>15</permissions>
    <subscribed>false</subscribed>
    <uuid>6b3e0531-96a9-4675-bb82-215b715b20ca</uuid>
    <hasChildren>false</hasChildren>
  </folder>
  <folder>
    <author>okmAdmin</author>
    <created>2013-07-24T22:56:20+02:00</created>
    <path>/okm:root/beta</path>
    <permissions>15</permissions>
    <subscribed>false</subscribed>
    <uuid>41f1bace-58b4-41a9-b43e-dffc1ac9a954</uuid>
    <hasChildren>false</hasChildren>
  </folder>
</folderList>

To create a note in a OpenKM folder or document you can do this (previously you need to know the node UUID, in this case is 1b983809-8473-40f1-8e83-ff6b20088c08):

 $ curl -u okmAdmin:admin -i -H "Accept: application/json" -X PUT -H "Content-Type: application/json" -d 'Hello, world!' http://localhost:8080/OpenKM/services/rest/note/add/1b983809-8473-40f1-8e83-ff6b20088c08