REST Documentation

From Kazle API

Jump to: navigation, search

The REST Documentation enlists each method available to you by the Kazle API. Each method requires a single HTTP request to the REST server located at http://api.kazle.com/index.php, each request must also be accompanied by the required POST parameters, there are default parameters required by each request and also extra parameters, which you can find in each of the method pages below.

Contents

Authentication

auth.create_token
Create's a new token to begin the authentication procedure.

auth.get_session
Fetches the API session to allow the API user access.

auth.end_session
Removes sessions preventing the API user from using the API services.

User

user.get
Fetches user information.

user.set
Sets the API user's information.

user.get_status
Get's only the user's current status.

user.set_status
Set's the API user's status.

user.get_location
Gets the current location for the API user.

user.set_location
Sets the current longitude and latitude location for the API user.

Photos

photos.get
Gets the user's photos

photos.get_albums
Gets the users album

photos.get_usertags
Returns the users tagged in the specified photos.

photos.tag_user
Tags a user in the specified photo.

photos.untag_user
Removes a specific tag from a specific photo.

photos.upload
Upload a photo

photos.set_caption
Sets the caption for a photo

Alerts

alerts.get
Get's the current API user's alerts.

Friends

friends.get
Gets the current API user's friends.

friends.get_groups
Gets the current API user's friend groups.

friends.are_friends
Let's you know if two specified users are friends.

Location

location.search
Performs a location search for the API user.

Feeds

feeds.get
Get's the API user's feeds.

feeds.post_comment
Posts a comment on a specified feed for the API user.

Personal tools