Navigation
Support - General System
Customizing the System
User - Adminstrator
User - Advertiser
- What is an Advertiser
- Summary of Services
User - Publisher
- What is a Publisher
- Summary of Services
Support - API
Toolbox

API Example Account Creation

From InClickAdServer

Creating A New Advertiser

This API Service Request will create an advertiser account. When compared to the factory user interface, this is comparable to the last step of the New Advertiser work flow.

The Code Example

<?php
require_once "../globals/globals.php";
require_once (INCLICK_CORE_DIR . "/external/classes/users/IMG_UserManagerClient.php");
require_once (INCLICK_CORE_DIR . "/external/classes/users/IMG_AdvertiserUser.php");
 
//THE BASE URL OF YOUR AD SERVER DEPLOYMENT
$base_url = INCLICK_WEB_URL;  
//THE SERVICE KEY TO ACCESS THE API
$service_key = "YOUR_API_SERVICE_KEY";  
 
//INSTANTIATE THE API CLIENT
$user_manager = new IMG_UserManagerClient($base_url, $service_key);
$advertiser_user = new IMG_AdvertiserUser();
 
//SET THE ADVERTISER DATA
$advertiser_user->setFirstName('First');
$advertiser_user->setLastName('Last');
$advertiser_user->setTitle('Title of User');
$advertiser_user->setCompany('inMotion Group');
$advertiser_user->setUsername('advertiser_namx');
$advertiser_user->setPhoneNumber('248-616-1943');
$advertiser_user->setPassword('testing');
$advertiser_user->setEmailAddress('advertiser_emailx@inmotiongroup.com');
 
$result = $user_manager->createAdvertiser($advertiser_user);
 
if($result->getErrorCode()) 
{ 
    $manager_result = $result->getReturnValue(); 
    if ($manager_result && $manager_result->getFieldValidationErrors()) 
    { 
         $error_array = $manager_result->getFieldValidationErrors(); 
         foreach ($error_array as $key => $value) 
         { 
          echo "Error with Field \"$key\": $value<br />\n"; 
         } 
    } 
    echo "Error Code: " . $result->getErrorCode() . ": "; 
    echo "" . $result->getErrorMessage() . "<br>"; 
}
else
{
    $user_manager_result = $result->getReturnValue();
    echo "Successfully created Advertiser Account ID " . $user_manager_result->getUserID() . "!";
}
?>

Breaking Down the Code

require "../globals/globals.php";

This require references the local inClick Ad Server deployment configuration files allowing your code to utilize the pre-packaged API Objects as well as the bundled PHPOlait services.

require_once (INCLICK_CORE_DIR . "/external/classes/users/IMG_UserManagerClient.php");
require_once (INCLICK_CORE_DIR . "/external/classes/users/IMG_AdvertiserUser.php");

These requires (includes) contain the API Objects and Classes needed for this API Service Request.

$base_url = INCLICK_WEB_URL;  
$service_key = "YOUR_API_SERVICE_KEY";

The $base_url is the URL to your inClick Ad Server deployment, the ad server root URL. For local host API usage, the constant of INCLICK_WEB_URL is defined in the globals.php file referenced earlier. Remote deployments, deployments where the ad server and API Request Location are not on the same server, would change this to the fully qualified URL to the ad server root directory.

The $service_key is one of the the api_service_keys values you created for your ad server. (more information)

$user_manager = new IMG_UserManagerClient($base_url, $service_key);
$advertiser_user = new IMG_AdvertiserUser();

This is where we create an instance of the classes needed to create a new advertiser account.

$advertiser_user->setFirstName('First');
$advertiser_user->setLastName('Last');
$advertiser_user->setTitle('Title of User');
$advertiser_user->setCompany('inMotion Group');
$advertiser_user->setUsername('advertiser_namy');
$advertiser_user->setPhoneNumber('248-616-1943');
$advertiser_user->setPassword('testing');
$advertiser_user->setEmailAddress('advertiser@somedomain.com');

This is where we define the values of the account we will be creating.

NOTE: You will notice that the inClick Ad Server standard work flow for new advertisers actually comprises of three actions - Creating a Campaign, Creating an Account, and Funding the Account. While the work flow looks to create the campaign first, the actual interaction with the system creates the account first, then creates the campaign of which is stored as a session until the account is created. The payment processing is performed after the account and first campaign is created.

$result = $user_manager->createAdvertiser($advertiser_user);

This line processes the API Server Request using the data as defined above.

if($result->getErrorCode()) 
{ 
    $manager_result = $result->getReturnValue(); 
    if ($manager_result && $manager_result->getFieldValidationErrors()) 
    { 
         $error_array = $manager_result->getFieldValidationErrors(); 
         foreach ($error_array as $key => $value) 
         { 
          echo "Error with Field \"$key\": $value<br />\n"; 
         } 
    } 
    echo "Error Code: " . $result->getErrorCode() . ": "; 
    echo "" . $result->getErrorMessage() . "<br>"; 
}
else
{
    $user_manager_result = $result->getReturnValue();
    echo "Successfully created Advertiser Account ID " . $user_manager_result->getUserID() . "!";
}

This section of code is provided to give you a visual confirmation of what occurred, or to give you a visual confirmation of the error that occurred.

Retrieved from "http://docs.inclick.net/index.php/API_Example_Account_Creation"

Category: API Usage