CSV: Creating Users with CSV

Getting Ready

Follow the instructions from the first two sections of the Creating Your First User article to setup and configure the Mambo PHP SDK.

The Script

Below you will find a script that loads users into Mambo based on a CSV file. The CSV file can also be found below so that you can follow the same structure for your data. Note that both files are also available for download.

In order to use the script you will need to take the following steps:

• Configure the fields in the script that require your input (see below)
• Add your users to the CSV file
• Setup the Mambo PHP SDK as explained in Creating Your First User

There are 4 fields in the script that require your input:

• serverUrl: this is the location of your Mambo installation. For example, if you are using the SaaS platform that would be https://api.mambo.io
• publicKey: this is your public API Key. In the SaaS platform this can be accessed here: https://api.mambo.io/#keys
• privateKey: this is your private API Key. In the SaaS platform this can be accessed here: https://api.mambo.io/#keys
• siteUrl: this is the site for which you are creating the users. In the SaaS platform this can be accessed here: https://api.mambo.io/#config/sites

Once everything is configured you can run your CSV loader with the following command:

php user_loader.php sample_user_data.csv

The user_loader.php script:

<?php

// Import the library files
require_once('sdk/Mambo.php');


// --------------- CONFIGURATION START ----------------

// Configure server and security variables
$serverUrl = "INSERT_MAMBO_SERVER_URL";
$publicKey = "INSERT_MAMBO_PUBLIC_KEY";
$privateKey = "INSERT_MAMBO_PRIVATE_KEY";
$siteUrl = "INSERT_MAMBO_SITE_URL";

// --------------- CONFIGURATION END ----------------


// Initialise the clients credentials and end point URL, this only needs to be done once
MamboClient::setCredentials( $publicKey, $privateKey );
MamboClient::setEndPointBaseUrl( $serverUrl );

// Use default timezone to parse dates
date_default_timezone_set("UTC");


// Check if a CSV file was supplied
if( $argc != 2 ) {
 exit("Please provide a CSV file name as an argument i.e. php user_loader my_file.csv");
}


// Open the CSV file
$csvFileName = $argv[1];
$handle = fopen( $csvFileName, "r" );

if( $handle === FALSE ) {
 exit("Failed to open the CSV file: " + $csvFileName);
}


// Process the CSV file
$row = 0;

while( ( $data = fgetcsv( $handle, 1000, "," ) ) !== FALSE )
{
 $row++;

debugLog( "---------------------------------" );
 debugLog( "Parsing row number: " . $row );

if( $row == 1 ) {
 debugLog( "Head row: skipping" );
 continue;
 }

createUser( $data );

debugLog( "Completed row number: " . $row );
}

// Close the CSV file
fclose( $handle );
exit();


// --------------- Helper Functions ----------------


// Try to create the user unless they already exist
function createUser( $data )
{
 global $siteUrl;

$uuid = $data[0];
 debugLog( "Creating user: " . $uuid );

$userData = createUserData( $uuid, $data );
 $user = MamboUsersService::create( $siteUrl, $userData );
 validateUserCreation( $uuid, $user );

return $uuid;
}


function createUserData( $uuid, $data )
{
 $email = $data[1];
 $firstName = $data[2];
 $lastName = $data[3];

$userDetails = new UserDetails();
 $userDetails->setEmail( $email );
 $userDetails->setFirstName( $firstName );
 $userDetails->setLastName( $lastName );
 $userData = new UserRequestData();
 $userData->setUuid( $uuid );
 $userData->setIsMember( true );
 $userData->setDetails( $userDetails );
 return $userData;
}


function validateUserCreation( $uuid, $user ) {
 if( isset( $user->error ) ) {
 if( strcmp( $user->error->type, "DuplicateException" ) === 0 ) {
 debugLog( "Existing user on server: " . $uuid );
 } else {
 debugLog( "An unexpected error occurred! Dumping output and terminating." );
 var_dump( $user );
 exit();
 }
 }
}


// Basic output to the terminal
function debugLog( $text ) {
 echo $text . "\n";
}

The sample_user_data.csv:

uuid,email,firstname,lastname
1,[e-mail],Alan,Robertson
2,[e-mail],Giulia,Grey

The fields in the CSV file represent:

• UUID: this is the unique user ID. You can set which ever ID works best for your systems. Ideally this would be your unique corporate identity or the identity used during SSO to identify users across systems.
• Email: this would be the user's email, it needs to be a valid email.
• Firstname: the user's first name
• Lastname: the user's last name

Download the files below: