Rest Service APIs

The third parties want to integrate and extend the Social capability and features and Social REST Services APIs are dedicated for them to complete that. By using these REST APIs, the third parties can write any applications (desktop apps, mobile apps, web apps) to integrate with Social services and business.

Conventions:

The entry point for Social Rest service must be: /{rest_context_name}/private/api/social/{version}/{portalContainerName}/{social_resources}/. An example of activities resources: /rest/private/api/social/v1-alpha3/portal/activity/.

There are 3 types of parameters on each URL:

{server_params}: this is the unchanged parameter for a specified server.

:id: this param is for a specified data object, for example, activity Id and identity Id.

format: this is the supported data format. It can be JSON, XML, RSS, or ATOM.

Notes:

Currently, only the basic authentication is supported. Please see more details at http://en.wikipedia.org/wiki/Basic_access_authentication.

The JSON support is mandatory. The other format SHOULD be supported too (XML, RSS, ATOM). The supported formats will be specified by the detailed documentation for the REST resources.

The rest_context_name and portal_container_name parameters are used as follows:

In Social standalone:
- rest_context_name: rest-socialdemo;
- portal_container_name: socialdemo;

In eXo Platform:
- rest_context_name: rest;
- portal_container_name: portal;