You are looking at documentation for an older release. Not what you want? See the current release documentation.
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.
/v1/calendar
allows developers to work with eXo Calendar, is available as of 4.2.
/v1/social
allows developers to work with eXo Social,
in other words, with user profile, connection, activity and space objects. It is new in 4.4.
Base URL and Rest context
Here is an example of the full URL: http://localhost:8080/rest/private/v1/social/users.
You should use the URL /rest/private
to access the APIs.
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.
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.