API
GROU.PS API Documentation
Go
to http://grou.ps/
Click
“Add new application” link from top right.
Type
your Application name and then submit form.
Your
application should be created. You can get api key and api secret from
applications list.
API Methods
|
Module |
user |
||
|
Function |
getUser |
||
|
Method |
GET |
||
|
Parameters |
|||
|
member |
Member ID of Member that you want to get
data |
||
|
user |
|||
|
Function |
getActions |
||
|
Method |
GET |
||
|
Parameters |
|||
|
member |
Member ID of Member that you want to get
actions |
||
|
videos |
|||
|
Function |
getAllVideos |
||
|
Method |
GET |
||
|
Parameters |
|||
|
offset |
Offset value for records. Default value
is 0. |
||
|
per_page |
Per page value for records. Default value
is 20. |
||
|
Module |
videos |
||
|
Function |
getAllVideosByMemberID |
||
|
Method |
GET |
||
|
Parameters |
|||
|
offset |
Offset value for
records. Default value is 0. |
||
|
per_page |
Per page value for
records. Default value is 20. |
||
|
member_id |
Member ID of member
that you want to get videos. |
||
|
videos |
|||
|
Function |
getVideo |
||
|
Method |
GET |
||
|
Parameters |
|||
|
video_id |
ID of video |
||
|
Module |
videos |
||
|
Function |
shareVideo |
||
|
Method |
POST |
||
|
Parameters |
|||
|
title |
Video Title |
||
|
url |
The url of video. For example if it's a
Youtube video url must be http://www.youtube.com/watch?v=syJk4k5plXU. We are supporting Youtube, MetaCafe and
DailyMotion services. |
||
|
member_id |
|||
|
Module |
photos |
||
|
Function |
getAllPhotos |
||
|
Method |
GET |
||
|
Parameters |
|||
|
offset |
Offset value for
records. Default value is 0. |
||
|
per_page |
Per page value for
records. Default value is 20. |
||
|
album_id |
Album ID of photos.
Default value is -1. |
||
|
photos |
|||
|
Function |
getAllPhotosByMemberID |
||
|
Method |
GET |
||
|
|
|
||
|
Parameters |
|||
|
offset |
Offset value for records. Default value
is 0. |
||
|
per_page |
Per page value for records. Default value
is 20. |
||
|
album_id |
Album ID of photos. Default value is -1. |
||
|
member_id |
|||
|
Module |
photos |
||
|
Function |
deletePhoto |
||
|
Method |
GET |
||
|
Parameters |
|||
|
photo_id |
ID of photo |
||
|
Module |
blogs |
||
|
Function |
getAllPosts |
||
|
Method |
GET |
||
|
Parameters |
|||
|
offset |
Offset value for records. Default value
is 0. |
||
|
per_page |
Per page value for records. Default value
is 20. |
||
|
Module |
blogs |
||
|
Function |
getAllPostsByMemberID |
||
|
Method |
GET |
||
|
Parameters |
|||
|
offset |
Offset value for records. Default value
is 0. |
||
|
per_page |
Per page value for records. Default value
is 20. |
||
|
member_id |
|||
|
Module |
blogs |
||
|
Function |
getPost |
||
|
Method |
GET |
||
|
Parameters |
|||
|
post_id |
ID of Post you want
to get. |
||
|
Module |
blogs |
||
|
Function |
sendPost |
||
|
Method |
POST |
||
|
Parameters |
|||
|
title |
Post title. |
||
|
body |
Post body. |
||
|
member_id |
ID of Member that
you want to add video with it's account. |
||
|
Module |
blogs |
||
|
Function |
deletePost |
||
|
Method |
GET |
||
|
Parameters |
|||
|
post_id |
Post title. |
||
|
groups |
|||
|
Function |
getAllSubgroups |
||
|
Method |
GET |
||
|
Parameters |
|||
|
offset |
Offset value for records. Default value is 0. |
||
|
per_page |
Per page value for records. Default value is 20. |
||
|
Module |
groups |
||
|
Function |
getSubgroup |
||
|
Method |
GET |
||
|
Parameters |
|||
|
subgroup_id |
ID of Subgroup. |
||
|
calendar |
|||
|
Function |
getAllEvents |
||
|
Method |
GET |
||
|
Parameters |
|||
|
offset |
Offset value for records. Default value
is 0. |
||
|
per_page |
Per page value for records. Default value
is 20. |
||
|
year |
Year value of event. |
||
|
Module |
calendar |
||
|
Function |
getAllEventsByMemberID |
||
|
Method |
GET |
||
|
Parameters |
|||
|
offset |
Offset value for records. Default value
is 0. |
||
|
per_page |
Per page value for records. Default value
is 20. |
||
|
year |
Year value of event. |
||
|
member_id |
|||
|
links |
|||
|
Function |
getAllLinks |
||
|
Method |
GET |
||
|
Parameters |
|||
|
offset |
Offset value for records. Default value is 0. |
||
|
per_page |
Per page value for records. Default value is 20. |
||
|
links |
|||
|
Function |
getAllLinksByMemberID |
||
|
Method |
GET |
||
|
Parameters |
|||
|
member_id |
Member ID of member that you want to get links. |
||
|
Module |
links |
||
|
Function |
getLink |
||
|
Method |
GET |
||
|
Parameters |
|||
|
link_id |
ID of link. |
||
Example
Code For API Client Usage
You
can download API client from http://github.com/gurkanoluc/GROU.PS-PHP-Api-client
|
$client
= new GroupsAPIClient(array( 'api_key'
=> GROUPS_API_KEY, 'api_secret'
=> GROUPS_API_SECRET, 'group_name'
=> GROUPS_GROUP_NAME )); $photos
= $client->api('photos', 'getAllPhotos', array( 'limit'
=> 30, 'offset'
=> 0 )); |