Users

Authentication Key

HTTP Basic authentication to obtain an authentication key (Auth) for future requests. An authentication key will last for a up to 2 hours or until the user’s password is changed.

 

GET URL: http:/{endpoint}/user

API Call: http://apiv1.scribblelive.com/user/?Token={Api Token}&Format=json

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Username true string The email address of the user being authenticated to make calls to the API.
Password true string The password of the user being authenticated.
Format string Format of the data returned by the API call. Can be either “xml”, “json” or “html”.

 

Example PHP script which returns the user’s Id, Name, Avatar and Auth in the JSON format. You need to set $api_token, $username and $password:

<?php
$api_token = “xxxxxxxx”; // generate token here: https://client.scribblelive.com/client/API.aspx (need to be logged in to ScribbleLive)
$username = “xxxx@xxx.com”; // email address registered with ScribbleLive
$password = “xxxxxxxxx”; // scribblelive password
$url = “http://apiv1.scribblelive.com/user/?Token=”.$api_token.”&Format=json“; // make sure you have entered your api token aboveprint get_data($url,$username,$password);function get_data($url,$username,$password) {
$ch = curl_init();
$timeout = 5;
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $timeout);
curl_setopt($ch, CURLOPT_USERPWD, $username . “:” . $password);
curl_setopt($ch, CURLOPT_HTTPHEADER,array(‘Content-Type: application/json’));
$data = curl_exec($ch);
curl_close($ch);
return $data;
}
?>

…………………………………………………………………………………………………………………..

User Id

Displays detailed information about the user with id {User Id}.

 

GET URL: http:/{endpoint}/user/{User Id}

API Call: http://apiv1.scribblelive.com/user/{User Id}/?Token={Api Token}&Auth={Authentication Key}&Format=json

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Token true string The token is a dedicated authorization key provided to the client to consume the API.
User Id true integer The ID of the user whose information is being retrieved.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials.
Format string Format of the data returned by the API call. Can be either “xml”, “json” or “html”.

…………………………………………………………………………………………………………………..

User Name & Avatar

GET – Sets the authenticated user’s name.
POST – Sets the authenticated user’s avatar.

 

GET or POST URL: http:/{endpoint}/user

API Call: http://apiv1.scribblelive.com/user/?Token={Api Token}&Name={New name}&Auth={Authentication Key}&Format=json

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Name true string The name that the user’s name should be set to.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials.
Format string Format of the data returned by the API call. Can be either “xml”, “json” or “html”.

…………………………………………………………………………………………………………………..

Clients

Shows all the clients to which the user account is connected, and the user’s respective client permissions on each.

 

GET URL: http:/{endpoint}/user/{User Id}/clients

API Call: http://apiv1.scribblelive.com/user/{User Id}/clients/?Token={Api Token}&Auth={Authentication Key}&Format=json

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Token true string The token is a dedicated authorization key provided to the client to consume the API.
User Id true integer The ID of the user to get information about.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials.
Format string Format of the data returned by the API call. Can be either “xml”, “json” or “html”.

…………………………………………………………………………………………………………………..

Social Accounts

Shows all the social accounts to which the user account is connected.

 

GET URL: http:/{endpoint}/user/{User Id}/social

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
User Id true integer The ID of the user to get information about.
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials.

…………………………………………………………………………………………………………………..

Anonymous Account

Creates an anonymous account for commenting. Can use HTTP GET or POST.

If an image file is included via HTTP POST, the image will be resized to 50px by 50px and used as the avatar of the user account.

{IP Address} should be the current IP of the user, but is optional. If it is not passed, we’ll automatically use the IP of the request.

Note: HTTP POST an image file (JPG, GIF, PNG)

 

GET or POST URL: http:/{endpoint}/user/create

API Call: http://apiv1.scribblelive.com/user/create/?Token={Api Token}&Name={New name}&IP={IP Address}&Auth={Authentication Key}&Format=json

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Token true string The token is a dedicated authorization key provided to the client to consume the API.
Name true string The name that the user’s name should be set to.
IP string The IP address of the anonymous user
Auth true string The authentication key ensures the user of the API has been authenticated to use the service. The authentication key can be obtained by making a call to /user with the user’s credentials.
Format string Format of the data returned by the API call. Can be either “xml”, “json” or “html”.

…………………………………………………………………………………………………………………..

Passport User

Creates a new user with a passport client for the given email address. Note: HTTP POST an image file (JPG, GIF, PNG)

 

POST URL: http:/{endpoint}/user/passport

 

Path Parameters:

NAME REQUIRED TYPE DESCRIPTION
Token true string The token is a dedicated authorization key provided to the client to consume the API.
IP Address true string The IP address of the anonymous user
First Name true string The user’s first name
Last Name true string The user’s last name
Email Address true string The user’s email address
Phone true string The user’s phone number
Company true string The user’s company
Country string The user’s country
Organization Type string The user’s company’s organization type
Position string The user’s position in the company
Expected Use string The way the user expects to use ScribbleLive
Agree to TOS true integer Whether or not the user agrees to the TOS

…………………………………………………………………………………………………………………..

Advertisements