API
Documentation
Contents
User
Management & Accessing user info
Status
Updates (what are you doing today!)
Media Next or Previous
Album Rows
Followers
/ Friends / Following
Followers / Friends /
Following
|
Status Code |
Description |
|
004 |
Call is not define in
the api. |
|
001 |
An unknown error occurred. Please try
again. |
|
0 |
Failed. |
|
1 |
Success. |
|
2 |
The service is currently
not available. Please try again later. |
|
3 |
Invalid API key. |
|
4 |
Invalid signature. |
|
5 |
Invalid version number. |
|
6 |
Invalid call id. |
|
900 |
The application has exceeded the maximum
number of requests allowed. Please try again later. |
|
101 |
One of the parameters
specified is invalid. |
|
404 |
One of the required parameters is missing. |
|
500 |
An user must be logged
in to perform this request. |
|
501 |
The currently logged in user does not have
appropriate permissions to perform this request. |
Basic Authentication sends user credentials in the header of the HTTP request. This makes it easy to use, but insecure and difficult to track.
Keeping the session alive!: when you login first time using basic auth, you will get session id (sid) in response code, you can use that session id in url to continue the user session on other pages without needing to send username and password again.
Note: if you need to continue session from a different server, then you must pass session id with ip of a old server which session was created from, else it won’t authenticate and log you out. Ex: http://path_to_the _page.com/status/sid=session_id&ip=old_server_ip_if_server_changed.
oAuth is required for accessing private data of a user and user must give permission to application for accessing there private data.
Register oAuth application at http://username.iyobo.com/oauth/ (replace username with your username).
Requesting Token: http:://iyobo.com/oauth/request_token
Authorizing from user: http://iyobo.com/oauth/authorize
Accessing Token: http://iyobo.com/oauth/access_token
oAuth Tools and
articles:
· http://oauth.net/code
· http://en.wikipedia.org/wiki/OAuth
· http://term.ie/oauth/example/client.php
Managing User and accessing his data, of course with his permission.
We have 5 different sizes profile avatars
for all the users. Which are following:
1.
Custom 300x225 (large size) for site use
mostly.
2.
128x128
3.
64x64
4.
48x48
5.
32x32
These
sizes changes based on dimension of the image. The above sizes are max sizes
for each dimension, which means if they are vertically bigger, then there real
size will be different, so the images stay in their original look and don’t
look stretched apart.
You
can retrieve the profile avatars with following links:
1.
http://username.iyobo.com/avatar/custom.jpg
2.
http://username.iyobo.com/avatar/128.jpg
3.
http://username.iyobo.com/avatar/64.jpg
4.
http://username.iyobo.com/avatar/48.jpg
5.
http://username.iyobo.com/avatar/32.jpg
Links
are self explanatory. If there is no user profile avatar, then it will retrieve
the default avatar and show that.
Managing news feed.
Everyone
Feed List – [GET] http://iyobo.com/status.xml
every user status updates
Parameters
|
Name |
Description |
Required |
Default |
|
after |
Pagination use for skipping rows and start displaying after it. |
No |
0 |
|
show |
Pagination use for limiting to pull the certain amount of rows |
No |
20 |
|
|
|
|
|
Search Feed
list – [GET] http://iyobo.com/status/{type}/{search_word}.xml
Accessing list of comments of the media.
Parameters
|
Name |
Description |
Required |
Default |
|
Search_word |
Search word
to search for |
Yes |
Null |
|
type |
Filter by
type (image, video, feed, media (images, videos) or null for all) |
No |
Null |
|
after |
Pagination use for skipping rows and start displaying after it. |
No |
0 |
|
show |
Pagination use for limiting to pull the certain amount of rows |
No |
20 |
|
|
|
|
|
User Feed
List – [GET] http://username.iyobo.com/status/{type}.xml
Accessing list of feeds for user and his fiend/following people
feeds which can be filter by parameters.
Parameters
|
Name |
Description |
Required |
Default |
|
username |
username of
the feed owner |
Yes |
|
|
type |
Filter by
type (image, video, feed, media (images, videos) or null for all) |
No |
Null |
|
after |
Pagination use for skipping rows and start displaying after it. |
No |
0 |
|
show |
Pagination use for limiting to pull the certain amount of rows |
No |
20 |
|
|
|
|
|
User Self Feed
List – [GET] http://username.iyobo.com/status/ifeed/{type}.xml
Accessing list of feeds for user only and not his friends or anyone
else.
Parameters
|
Name |
Description |
Required |
Default |
|
username |
username of
the feed owner |
Yes |
|
|
type |
Filter by
type (image, video, feed, media (images, videos) or null for all) |
No |
Null |
|
after |
Pagination use for skipping rows and start displaying after it. |
No |
0 |
|
show |
Pagination use for limiting to pull the certain amount of rows |
No |
20 |
|
|
|
|
|
User
Mentions Feed List – [GET] http://username.iyobo.com/status/mentions.xml
Accessing list of feeds where user have been mentioned at.
Parameters
|
Name |
Description |
Required |
Default |
|
username |
username of
the feed owner |
Yes |
|
|
after |
Pagination use for skipping rows and start displaying after it. |
No |
0 |
|
show |
Pagination use for limiting to pull the certain amount of rows |
No |
20 |
|
|
|
|
|
Thread Feed
List – [GET] http://username.iyobo.com/status/thread/{thread_id}.xml
feed discussion list for a thread with their replies.
Parameters
|
Name |
Description |
Required |
Default |
|
username |
username of
the feed owner |
Yes |
|
|
thread_id |
Thread id to
pull the conversation of |
Yes |
Null |
|
after |
Pagination use for skipping rows and start displaying after it. |
No |
0 |
|
show |
Pagination use for limiting to pull the certain amount of rows |
No |
20 |
|
|
|
|
|
Feed Create – [POST] http://username.iyobo.com/status.xml
create a feed
Parameters
|
Name |
Description |
Required |
Default |
|
username |
username of
the feed owner |
Yes |
|
|
type |
Type of
feed (feed, image, video or audio) |
Yes |
feed |
|
text |
User feed
(can be empty if thumbnail is set) |
Yes |
|
|
reply_to |
Replying
to feed, add feed id of the replying feed |
No |
0 |
|
media_id |
Media id for which is being talk about |
No |
|
|
thumbnail |
Thumbnail
link for the image/video/audio |
No |
|
|
direct_link |
1 link
with feed, with or without thumbnail |
No |
|
|
|
|
|
|
Feed Modify – [PUT] http://username.iyobo.com/status/{feed_id}.xml
Modifying user feed, only user himself can do.
Parameters
|
Name |
Description |
Required |
Default |
|
username |
username of
the feed owner |
Yes |
|
|
feed_id |
Feed id to make
modification to |
Yes |
|
|
type |
Type of
feed (feed, image, video or audio) |
No |
feed |
|
text |
User
feed (can be empty if thumbnail is set) |
No |
|
|
reply_to |
Replying
to feed, add feed id of the replying feed |
No |
0 |
|
media_id |
Media id for which is being talk about |
No |
|
|
thumbnail |
Thumbnail
link for the image/video/audio |
No |
|
|
direct_link |
1 link
with feed, with or without thumbnail |
No |
|
|
|
|
|
|
Feed Delete – [DELETE] http://username.iyobo.com/status/{feed_id}.xml
Deleting feed
Parameters
|
Name |
Description |
Required |
Default |
|
username |
username of
the user |
Yes |
|
|
feed_id |
Feed id to
make modification to |
Yes |
|
|
|
|
|
|
Feed Vote – [POST] http://username.iyobo.com/status/{feed_id}.xml
Adding user vote on the feed, thumbs up or thumbs down for a feed.
Parameters
|
Name |
Description |
Required |
Default |
|
username |
username of
the feed owner |
Yes |
|
|
feed_id |
feed id
which needs to be modified |
Yes |
|
|
vote |
“up” or
“down” vote on the comment |
Yes |
down |
|
|
|
|
|
Feed Report
Spam – [PUT] http://username.iyobo.com/status/{feed_id}.xml
Reporting Spam
Parameters
|
Name |
Description |
Required |
Default |
|
username |
username of
the feed owner |
Yes |
|
|
feed_id |
Feed id to
make modification to |
Yes |
|
|
spam |
What is
problem with this feed. user massage |
Yes (can be
null) |
|
|
|
|
|
|
To organize media, use albums. Also accessing the albums or
its media, it will check user permission first, if he is allowed or given
permission to access the album or its media.
Album View – [GET] http://username.iyobo.com/album/{album_id}/only.xml
Pass album id and it will return all the sub album of the album. If
you don’t pass any album id, it will show top parent albums
Parameters
|
Name |
Description |
Required |
Default |
|
username |
username of
the album owner |
Yes |
|
|
parent_id |
Album id to
get the sub albums of this album |
No |
NULL |
|
after |
Pagination use for skipping rows and start displaying after it. |
No |
0 |
|
show |
Pagination use for limiting to pull the certain amount of rows |
No |
20 |
|
|
|
|
|
Album
Create – [POST]
http://username.iyobo.com/album/only.xml
it will create album in the parent given album.
Parameters
|
Name |
Description |
Required |
Default |
|
username |
username of
the album owner |
Yes |
|
|
name |
Name of the
album |
Yes |
|
|
parent_id |
Parent album
id to put this album in the parent album |
No |
|
|
private |
‘yes’ (if
its private) or ‘no’ (if it’s not private) |
No |
no |
|
|
|
|
|
Album
Modify – [PUT] http://username.iyobo.com/album/{album_id}/only.xml
Modifies the album name and move the album to new location, if
parent album was provided too.
Parameters
|
Name |
Description |
Required |
Default |
|
username |
username of
the album owner |
Yes |
|
|
album_id |
Album id to
make modification to |
Yes |
|
|
name |
Name of the
album |
No |
|
|
parent_id |
Parent album
id to put this album in the parent album |
No |
|
|
private |
‘yes’ (if
its private) or ‘no’ (if it’s not private) |
No |
no |
|
|