Introduction
Synble is providing API for accessing its services and databases through OpenSocial interfaces. Current version 0.1 is a subset of OpenSocial v0.9 which is currently in draft mode and under development.
Limitations:
- Not fully OpenSocial compatible. App concept is currently totally missing.
- @me is not supported
- This API can and will be changed without prior notice.
Privacy and access policies
API access policy is a way to grant read or write access to different resources. In most cases policies are defined by the user. Some API's has the minimum policy already specified which means that there won't be separate queries for user consent.
SelfReadPolicy
Access to read from the resource under authenticated user account
SelfWritePolicy
Access to write to the resource under authenticated user account
FriendReadPolicy
Access to read from the resource under authenticated user account for all the friends.
FriendWritePolicy
Access to write to the resource under authenticated user account for all the friends.
Supported APIs
Person API
Request: GET http://www.synble.com/opensocial/{username}/@all
Response: List of all contacts
Access policy:
Authentication is required for this data. Only data under authenticated user account is accessible. User has to grant consent for accessing this API.
- Minimum: -
- User grantable: SelfReadPolicy
Request: GET http://www.synble.com/opensocial/{username}/@friends
Response: List of all friends
Access policy: Authentication is required for this data. Only data under authenticated user account is accessible.
- Minimum: FriendReadPolicy
- User grantable: -
Request: GET http://www.synble.com/opensocial/people/{username}/@self
Response: Profile record of authenticated user
Access policy: Authentication is required for this data. Only data under authenticated user account is accessible.
- Minimum: FriendReadPolicy
- User grantable: -
Activities API
Request: GET http://www.synble.com/opensocial/activities/{username}/@self
Response: Activities generated by authenticated user. E.g. SMS received, SMS sent, call received, called.
TODO: add an example response.
Access policy: Authentication is required for this data. Only data under authenticated user account is accessible. User has to grant consent for accessing this API.
- Minimum: SelfReadPolicy
- User grantable: -
Request: GET http://www.synble.com/opensocial/activities/{username}/@friends
Response: Activities generated for friends by the user. E.g. SMS received, SMS sent, call received, called. No other information available than an event.
TODO: add an example response.
Access policy: Authentication required. Visible only friends. User has to grant consent for accessing this API.
- Minimum: -
- User grantable: FriendReadPolicy (system-wide policy)
Messages API
Inbox
API for accessing received messages
Request: GET http://www.synble.com/opensocial/messages/{username}/@inbox
Response: 10 latest received messages
Access policy: Authentication is required for this data. Only data under authenticated user account is accessible. User has to grant consent for accessing this API.
- Minimum: -
- User grantable: SelfReadPolicy
Outbox
API for sending messages
Request: PUT http://www.synble.com/opensocial/messages/{username}/@outbox
Response: HTTP code 201 if message was successfully sent.
Access policy: Authentication is required. Only data under authenticated user account is accessible. User has to grant consent for accessing this API.
Restrictions: Only 1 recipient is supported. Recipient must be friend.
- Minimum: -
- User grantable: SelfWritePolicy
Request: GET http://www.synble.com/opensocial/messages/{username}/@outbox
Response: List of sent messages
Access policy: Authentication is required. Only data under authenticated user account is accessible. User has to grant consent for accessing this API.
- Minimum: -
- User grantable: SelfReadPolicy