9.4. Working with eXo REST APIs

New REST APIs introduced in Platform 4.x

This part of the Developer guide introduced two REST APIs. These "v1" APIs are at Experimental level.

Base URL and Rest context

Here is an example of the full URL: http://localhost:8080/rest/private/v1/social/users.

While you can also use /portal/rest, notice the /rest context is designed for secure accesses to the Rest services, so it is recommended. You can omit /private for an anonymous access, however almost all methods of the two APIs require authentication.

Note

The paths are case-sensitive. For example, use /v1/social/usersRelationships, don't use /v1/social/usersrelationships.

Useful resources and tools

If you want to start from learning concepts of REST framework, you should read the Java (Oracle) documentation:

If you want to test the two APIs simply, a good way is using a web browser with plugins for Rest and JSON. For example with Chrome, you can install Advanced Rest Client and JSON Formatter extensions.

The following tutorials help you develop your eXo REST client in Java and JavaScript. The sample projects can be found at GitHub.

Copyright ©. All rights reserved. eXo Platform SAS
blog comments powered byDisqus