Use APIs for IBM
® Connections people and activity streams to customize how users interact with the activity stream and retrieve data about people.
Activity streams API
Connections activity stream provides an improved microblogging experience that allows you to gather information in a meaningful way and act on it in context. IBM
Connections default gadgets are available for users to attach files to status updates, use hashtags to tag updates, repost status updates, and click Like
to recommend updates. Users can also preview images and download files to work on them locally.
As a developer, you can take advantage of a IBM
Connections REST API that is designed exclusively for interacting with the activity stream. This Activity Stream API is based on a version of the osapi.activitystreams API that is defined in the OpenSocial specification.
Differences between IBM Connections and OpenSocial implementations
Connections provides several extensions to the Activity Streams API to ensure compatibility with the rich feature set required by IBM
Connections. For example, you can use extensions to filter events by application, specify user IDs to return events from other users, specify URL parameters, and more.
For more information, see the Connections API documentation.
The People API provides person data to gadgets through the Apache Shindig PersonService interface, which uses PersonServiceImpl in sn.infra. The PersonServiceImpl links in with a PersonServiceRemoteImpl through the rproxyservice. The IBM
Connections People API is based on the OpenSocial People API (osapi.people), although some limitations exist.
Many fields in the implementation of the Shindig interface are currently ignored, including the groupId
, and fields
parameters. An empty person is returned if a request is made without first logging in. Any request for one or more persons returns OpenSocial person objects as specified by the given userId(s) and securityToken, which contain:
OpenSocial REST Developer's Guide
- userId: Possible values include @me, @viewer, @owner, or an actual ID or array of IDs. OpenSocial regards login names as IDs. IBM Connections ID do not work. The default value is @me.
- groupId: Possible values include @self, @friends, and @all. The default value is @self, which is the actual userId or userIds that are provided under userId. groupIds other than @self are not currently supported.
- fields: Possible values include displayName and id. This parameter is currently ignored by the API.