The /v1/social Rest API, available as of Platform 4.3, is considered Experimental.
The API aims at giving the ability to work with Social data models via CRUD operations.
Here are some examples of what your client can feature using the API:
Create a user, change his/her password, update their profile and commit a logical deletion.
Send, cancel or accept a connection (also called relationship) request, remove a connection.
Get content of an activity stream, comment or like/unlike an activity.
Create a space, update some fields, delete the space.
Join an open space, leave the space or set a member as the space manager.
To understand how such tasks can be done by CRUD operations, the next tutorial will discuss the data models (as JSON entities). By that, you will get your hand in the abilities and the current limitation of the API.
Before starting the next tutorials, take a loot at some general characteristics. In a similar manner as Calendar Rest API, the Social API:
Uses four Http verbs: GET for Read, POST for Create, PUT for Update, and DELETE.
Uses JSON data format.
Uses the three parameters returnSize, limit and offset for paging.
When working with DateTime parameters, Calendar API uses ISO8601 format. With Social API you should always adjust the local DateTime values into UTC.
In the next tutorials, you will learn the data models, the access permission and Java/JavaScript code samples to use the API: