users > create | WS.WebTV API Reference | WebTV Solutions

Print

Building the Request

Request URL and GET vars

GET vars specific to this request:

Resulting Request URL:
The resulting request URL would be similar to this (don't forget to append the required info: key, timestamp, salt and signature):
https://....../api.php?go=users&do=create&{required information}

POST vars

The following POST vars are required.

Case 1 - Standard registration:

Case 2 - Registration using an external auth provider (WS.WebTV 1.8.5+):

The following POST vars are optional but require the Advanced User Management extension.

Response Examples

If the request was successful, you'll receive a response containing:
• ok: If the User was created (registered) successfully.
• id: The ID of the User.
• activation_key: The activation key.
Example:

{
    "ok": "User was registered successfully",
    "id": 78,
    "activation_key": "bj8g3dz5xsntprsy0icc"
}

If the request failed (for example, if the Username/Login is invalid), you'll receive a response like the following:

{
    "error": "REGISTRATION_ERROR",
    "error_long": "Invalid login"
}

Possible Error Messages
Besides the general errors, this request can return the following errors:

• REGISTRATION_ERROR | {Message}
It was not possible to create (register) the User because of the specified reason.

PHP Example Code

Preparing GET and POST data.

// The GET vars
$GET_VARS = array( 
					"go"        => "users",
					"do"        => "create"
					);

// The POST vars
$POST_VARS = array(
					"login" => "mrbean",
                    "password" => "123",
                    "alias" => "Mr. Bean",
                    "email" => "mrbean@beanmail.bean", 
                    "notify_webmaster" => 1, // Send a notification E-Mail to the Webmaster
                    
                    // ----- Optional fields (Advanced User Management extension required)
                    "status" => 2, // Pending verification
                    "send_user_verification_email" => 1, // Send a verification E-mail to the User
                    "store_post_registration" => 1, // Allow the Store Extension to perform post registration process
                    "access_level" => 5, // 5 (Free Subscriber)
                    "cms_access" => 1, // 1 Content Administrator access allowed
                    "name" => "Rowan", // The real name of the User
                    "surname" => "Atkinson ", // The surname/last name of the User
                    "gender" => 1, // 1 (male)
                    "birthdate_y" => 1955, // Birthdate year
                    "birthdate_m" => 1, // Birthdate month
                    "birthdate_d" => 6, // Birthdate day
                    "company" => "",
                    "address" => "",
                    "postal_code" => "",
                    "vat" => "",
                    "country" => England"",
                    "telephone" => "",
                    "web" => "http://www.mrbean.com/",
                    "notes" => "",
                    "avatar_display" => 3, // 3 (Gravatar, Monsterid)
                    "reg_referer" => "external api",
                    "reg_ip" => "xxx.xxx.xxx.xxx",
                    "reg_useragent" => "",
                    "social_page_facebook" => "http://www.facebook.com/MrBean",
                    "social_page_googleplus" => "",
                    "social_page_twitter" => "https://twitter.com/MrBean",
                    "social_page_linkedin" => "", 
                    "social_page_flickr" => "", 
                    "social_page_vkontakte" => "",
                    "social_page_tuenti" => "",
                    "social_page_other" => "",
                    "profile_page_privacy" => 0, // User profile page is public
                    "profile_page_about" => "Rowan Atkinson’s comic acting genius has created a highly original work for television. The Mr Bean series has been sold to 190 territories worldwide and has won an International Emmy and the Golden Rose of Montreux",
                    "profile_page_show_country" => 1, // Display the User country in its public profile
                    "profile_page_show_web" => 1, // Display the User Website in its public profile
                    "profile_page_show_social" => 1 // Display the User social links in its public profile
                    );

Generating the salt, timestamp, signature and sending the request
*** The following code block is common to all signed requests ***

// Collect the API Base URL and Credential info
$API_URL = "https://www.mywebtvdomain.tv/api.php";
$API_KEY_ID = "1b323a1cb879fd4e66530fbad07a32ee"; 
$API_SHARED_SECRET = "MWIzMjNhMWNiODc5ZmQ0ZTY2NTMwZmJhZDA3YTMyZWViOTQ3MDJiOGM2ZTU2NjE3"; // keep this safe!!!

// Generating salt and timestamp
$salt = md5(mt_rand());
$timestamp = time();
$signature = base64_encode(hash_hmac('sha256', $salt.$timestamp, $API_SHARED_SECRET, true));

// Generating the validation signature
// - Default method: using base64_encode(hash_hmac(...))
$signature = base64_encode(hash_hmac('sha256', $salt.$timestamp, $API_SHARED_SECRET, true)); // comment this line if using the next method
// - Simplified method - available since v60: using md5(). 
//   This method requires the variable $API_SIGNATURE_GENERATION_MODE = 1; in the config/Config.inc.php file.
// $signature = md5($salt."-".$timestamp."-".$API_SHARED_SECRET); // you must "uncomment" this line when using the simplified method

// Append the timestamp, salt, key and signature to the GET vars
$GET_VARS["timestamp"] = $timestamp; 	// UTC timestamp
$GET_VARS["salt"] = $salt;
$GET_VARS["key"] = $API_KEY_ID ;      // The API Key ID: This is public and is used by the API to identify the application;
$GET_VARS["signature"] = $signature;

// Create the request URL. Please note that if you do not use PHP buit in function 
// to create the HTTP query then don't forget to URL encode the values
$REQUEST_URL = $API_URL."?".http_build_query($GET_VARS); 
// The previous will build an URL like .../api.php?go=api_subject&do=api_action&etc...

// Create a new cURL resource and set the appropriate options
$ch = curl_init(); 
curl_setopt($ch, CURLOPT_URL, $REQUEST_URL); 
curl_setopt($ch, CURLOPT_POST, true); 
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_POSTFIELDS, $POST_VARS);
// If your PHP host does not have a valid  SSL certificate, you will need to turn off SSL
// Certificate Verification. This is dangerous (!), and should only be done temporarily
// until a valid certificate has been installed
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); // Turns off verification of the SSL certificate.
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Turns off verification of the SSL certificate.

// Sending the request to the API
$response = curl_exec($ch);

// Processing the response
if (!$response) { 
	echo 'API call failed'; 
} 
else
{
	print_r(json_decode($response,true)); 
}