Community articleIBM Connections OpenSocial API
Added by IBM contributorIBM on December 21, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

No abstract provided.

Overview


This page and those that follow represent a description of the REST API used to interact with the Open Social APIs implemented and extended by IBM Connections.

First amongst these is the Activity Stream API which is based on the Open Social adoption of the Activity Stream APIs from the separate ActivityStreams community. IBM Connections has both adopted and considerably extended this API to provide a comprehensive Activity Stream experience, adding support for such concepts as public and community scoped streams.

The microblogging API is a new API currently being proposed as a standard for Open Social adoption that facilitates the submission of short text messages (optionally including a file attachment) to a persons 'board'.

Finally, there is a minimal implementation of the Open Social people API in order to query some basic information about a given user.

It is worth noting that IBM has been a key contributor to the integration of ActivityStreams into the Open Social Standard and has pushed for inclusion of many of the features that enable the rich Activity Streams experience seen in IBM Connections 4.5.

Quick Start

As IBM Connections is an enterprise solution with all of the associated security and deployment considerations there are a number of things you may need to do to get up and running. In this section we cover the simplest scenario to get you up and running quickly in order to POST events to the Activity Stream.
Quick Start

Standards


IBM has been engaged with and contributing to the Activity Streams and Open Social standards. The information that these standards provide is duplicated in this documentation for ease of reference. Although they remain the definitive reference point for development, It is worth noting that there are many cases where more detail/disambiguation is needed for practical purposes. Later sections attempt to identify these areas and address where practical.
Standards Reference Overview

IBM Connections extensions

Every effort has been made to ensure that IBM Connections is fully compliant with standards in terms of its implementation of the standard Activity Stream API. However in many cases the API either does not provide enough in the way of features/options, or enough detail in how certain capabilities can be implemented. For this reason we have made a number of extensions to the standard definition. These are specifically designed to complement the standard, and should not conflict in either model or implementation.
IBM Connections Extensions Overview

Open Social API


In this section we include the relevant subset of the standard Open Social API that is referenced elsewhere in this document. Note : This is for convenience, and the standards themselves should generally be used in preference.
Open Social API Reference

IBM Connections Activity Stream API


In the API section we fully describe the required API for Activity Streams, duplicating the appropriate Open Social specifications as required and outlining where we extend as appropriate. The detail here ultimately reflects what is supported in the IBM Connections implementation of the Activity Stream standard.
IBM Connections Activity Stream API

IBM Connections People API


In the API section we fully describe the required API for People, duplicating the appropriate Open Social specifications as required and outlining where we extend as appropriate. The detail here ultimately reflects what is supported in the IBM Connections implementation of the People API part of the Open Social standard.
IBM Connections People API

IBM Connections Microblogging API


In this API section we describe the IBM Connections implementation for a Microblogging API.
IBM Connections Microblogging API

Authorization


In order to use the API effectively you will need to be able to authenticate and/or authorize access to the Activity Stream. In this section we explain the different mechanisms available to an API developer to access the Activity Stream directly and/or to access the Activity Stream as authorized by another user.
Authorization

Examples


In this section a number of user cases are discussed with full details as to the appropriate use of the Activity Stream standard in making REST calls.
Examples