user_add

Example Usage of

user_add

Add new user.

Description:

Add a new user to the system.

Endpoint:

/admin/api.php?api_action=user_add

HTTP method:

POST

Supported output formats:

xml, json, serialize

Requires authentication:

true

Parameters:

* indicates requirement. Underlined params include in URL, otherwise as part of the post body. POST data must be formatted as

Content-Type: application/x-www-form-urlencoded

. We don't accept any other input formats like JSON.

Variable	Description
api_action*	user_add
api_key*	Your API key
api_output	xml, json, or serialize (default is XML)
username*	Username for the new user.
password*	Password. Example: 'newpassword'
password_r*	Repeat password. Example: 'newpassword'
email*	Email address of the user. Example: '[e-mail]'
first_name*	First name of the user. Example: 'FirstName'
last_name*	Last name of the user. Example: 'LastName'
phone	Phone number of the user. Example: '332-220-1121'
group[] ] => Assign to Groups. Example: group[1] => 1, group[2*	2
lang	Language setting for this user. Possible values: chinese, danish, dutch, english, finnish, french, german, italian, portuguese, "portuguese - brazil", spanish, turkish
timezone	Timezone setting for this user

Example response:

Variable	Description
absid	Global ID for this user. Example: 3
lang	Language setting for this user. Example: english
local_zoneid	America/Chicago
username	Username for this user. Example: test1
first_name	First name for this user. Example: FirstName
last_name	Last name for this user. Example: LastName
email	Email address for this user. Example: [e-mail]
userid	User ID for this user. Example: 3
result_code	Whether or not the response was successful. Examples: 1 = yes, 0 = no
result_message	A custom message that appears explaining what happened. Example: User added
result_output	The result output used. Example: serialize

PHP Example

This is an example of using the user_add call with PHP. You can replicate the same idea in virtually any other programming language. The example shown is using serialize as the output format. You can change that to XML or JSON if you would like.

<?php

// By default, this sample code is designed to get the result from your installation and print out the result
$url = 'http://account.api-us1.com';


$params = array(

    // the API Key can be found on the "Your Settings" page under the "API" tab.
    // replace this with your API Key
    'api_key'      => 'YOUR_API_KEY',

    // this is the action that adds a user
    'api_action'   => 'user_add',

    // define the type of output you wish to get back
    // possible values:
    // - 'xml'  :      you have to write your own XML parser
    // - 'json' :      data is returned in JSON format and can be decoded with
    //                 json_decode() function (included in PHP since 5.2.0)
    // - 'serialize' : data is returned in a serialized format and can be decoded with
    //                 a native unserialize() function
    'api_output'   => 'serialize',
);

// here we define the data we are posting in order to perform an update
$post = array(
    'username'   => 'newuser',
    'password'   => 'newpassword',
    'password_r' => 'newpassword', // again :)
    'email'      => '[e-mail]',
    'first_name' => 'FirstName',
    'last_name'  => 'LastName',
    'phone'      => '332-220-1121',
    // assign to groups:
    'group[3]'   => 3, // main admin group
    //'group[4]' => 4, // some additional groups?
    'lang'       => 'english',
    'timezone'   => 'America/Chicago',
);

// This section takes the input fields and converts them to the proper format
$query = "";
foreach( $params as $key => $value ) $query .= urlencode($key) . '=' . urlencode($value) . '&';
$query = rtrim($query, '& ');

// This section takes the input data and converts it to the proper format
$data = "";
foreach( $post as $key => $value ) $data .= urlencode($key) . '=' . urlencode($value) . '&';
$data = rtrim($data, '& ');

// clean up the url
$url = rtrim($url, '/ ');

// This sample code uses the CURL library for php to establish a connection,
// submit your request, and show (print out) the response.
if ( !function_exists('curl_init') ) die('CURL not supported. (introduced in PHP 4.0.2)');

// If JSON is used, check if json_decode is present (PHP 5.2.0+)
if ( $params['api_output'] == 'json' && !function_exists('json_decode') ) {
    die('JSON not supported. (introduced in PHP 5.2.0)');
}

// define a final API request - GET
$api = $url . '/admin/api.php?' . $query;

$request = curl_init($api); // initiate curl object
curl_setopt($request, CURLOPT_HEADER, 0); // set to 0 to eliminate header info from response
curl_setopt($request, CURLOPT_RETURNTRANSFER, 1); // Returns response data instead of TRUE(1)
curl_setopt($request, CURLOPT_POSTFIELDS, $data); // use HTTP POST to send form data
//curl_setopt($request, CURLOPT_SSL_VERIFYPEER, FALSE); // uncomment if you get no gateway response and are using HTTPS
curl_setopt($request, CURLOPT_FOLLOWLOCATION, true);

$response = (string)curl_exec($request); // execute curl post and store results in $response

// additional options may be required depending upon your server configuration
// you can find documentation on curl options at http://www.php.net/curl_setopt
curl_close($request); // close curl object

if ( !$response ) {
    die('Nothing was returned. Do you have a connection to Email Marketing server?');
}

// This line takes the response and breaks it into an array using:
// JSON decoder
//$result = json_decode($response);
// unserializer
$result = unserialize($response);
// XML parser...
// ...

// Result info that is always returned
echo 'Result: ' . ( $result['result_code'] ? 'SUCCESS' : 'FAILED' ) . '<br />';
echo 'Message: ' . $result['result_message'] . '<br />';

// The entire result printed out
echo 'The entire result printed out:<br />';
echo '<pre>';
print_r($result);
echo '</pre>';

// Raw response printed out
echo 'Raw response printed out:<br />';
echo '<pre>';
print_r($response);
echo '</pre>';

// API URL that returned the result
echo 'API URL that returned the result:<br />';
echo $api;

echo '<br /><br />POST params:<br />';
echo '<pre>';
print_r($post);
echo '</pre>';?>