success (boolean) - whether the api call was successful or not
data (object)
uid (int) : the id of the user
username (name) : username of the user
auth_token (string) : unique token given to the current user session
errors (array of strings)[optional] - array of strings with errors that happened, if any
register_user
example data urls :
s-apis.learningfuze.com/blog/register.json
s-apis.learningfuze.com/blog/register_error.json
use: creates a user account
parameters:
email (string) : private email address of the user
display_name (string) : public username of the user
password (string) - min 8 characters :
response:
success (boolean) - whether the api call was successful or not
data (object)
uid (int) : the id of the user
email (string)
display_name (string) - Name to be displayed to other users
errors (array of strings)[optional]
text describing the error for end users to see
edit_user
example data urls :
s-apis.learningfuze.com/blog/edit.json
s-apis.learningfuze.com/blog/edit_error.json
use: edits a user’s information
parameters:
uid (string) : unique id of the user
auth_token (string) - unique token given to the current user session
display_name (string) [optional] : Name used for other users to se
password (string) [optional] - min 8 characters
profile_img (string) [optional] - image of the user profile. Default to a generic profile pic if none is uploaded
response:
success (boolean) - whether the api call was successful or not
data (object) - same as get_user_profile api call
errors (array of strings)[optional]
text describing the error for end users to see
logout_user
example data urls :
s-apis.learningfuze.com/blog/logout.json
s-apis.learningfuze.com/blog/logout_error.json
use: logs a user out of the system
parameters:
auth_token (string) - unique token given to the current user session
response:
success (boolean) - whether the api call was successful or not
data (NULL)
errors (array of strings) [optional]
text describing the error for end users to see
get_user_profile
example data urls :
s-apis.learningfuze.com/blog/profile.json
s-apis.learningfuze.com/blog/profile_error.json
use: retrieves information for a user. Information for [self] is only returned for the currently logged in user. [private] is only returned if the user is logged in
parameters:
uid (int) - Id of the user
auth_token (string) - unique token given to the current user session
response:
success (boolean) - whether the api call was successful or not
data (NULL)
uid (int) : the id of the user
email (string)[private][self] - email address of the user
name (string) - Profile name of the registered user
profile_img (string) - image of the user profile. Default to a generic profile pic if none is uploaded
last_login (int)[private] - unix timestamp of the last time the user logged in
is_logged_in (boolean)[private] - whether the user is currently logged in or not
recent_posts (array of int) - an array of blog post id’s