Community Website

REST API Documentation

This document describes the REST API and resources provided by eXo platform. The REST APIs are for developers who want to integrate eXo services into their application. A great advantage of using the REST API is that you can use any web development language to access the API.

An increasing number of eXo built-in apps are leveraging these REST APIs.

eXo’s REST APIs provide access to resources via URI paths. To use a REST API, your application will make an HTTP request and parse the response. Unless specified the REST APIs will send their response as a JSON structure, but some of them also support XML.

Your methods will be the standard HTTP GET or POST methods.

Structure of the REST URIs

URIs for an eXo REST API resource have the following structure: http://host:port/rest/[private]/uri

“private” is optional and will let you make an authenticated call using HTTP BASIC authentication with any eXo user credentials. The authorizations will be propagated on the server so that your calls will be granted or restricted according to the user privileges.


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