API Example Create a Publisher Account

From InClickAdServer

Creating a Publisher Account

This API Service Request will create a new Publisher account.

The Code Example

  1. <?php
  2. require_once "../globals/globals.php";
  3. require_once (INCLICK_CORE_DIR . "/external/classes/users/IMG_UserManagerClient.php");
  4. require_once (INCLICK_CORE_DIR . "/external/classes/users/IMG_PublisherUser.php");
  5.  
  6. //THE BASE URL OF YOUR AD SERVER DEPLOYMENT
  7. $base_url = INCLICK_WEB_URL;  
  8. //THE SERVICE KEY TO ACCESS THE API
  9. $service_key = "YOUR_API_SERVICE_KEY";  
  10.  
  11. //INSTANTIATE THE API CLIENT
  12. $user_manager = new IMG_UserManagerClient($base_url, $service_key);
  13. $publisher_user = new IMG_PublisherUser();
  14.  
  15. //SET THE PUBLISHER DATA
  16. $publisher_user->setFirstName('First');
  17. $publisher_user->setLastName('Last');
  18. $publisher_user->setTitle('Title of User');
  19. $publisher_user->setCompany('inMotion Group');
  20. $publisher_user->setAddress1('123 This Street');
  21. $publisher_user->setAddress2('Suite 100');
  22. $publisher_user->setCity('Troy');
  23. $publisher_user->setState('MI');
  24. $publisher_user->setPostalCode('48083');
  25. $publisher_user->setCountry('USA');
  26. $publisher_user->setPhoneNumber('248-616-1943');
  27. $publisher_user->setUsername('publisher_name');
  28. $publisher_user->setPassword('testing');
  29. $publisher_user->setEmailAddress('publisher_email@inmotiongroup.com');
  30. $publisher_user->setCommissionRate($action_vars["network_base_commission"]/100);
  31. $publisher_user->setPaymentMethod('check');
  32. $publisher_user->setWebsiteDescription('This is information about my site');
  33. $publisher_user->setWebsiteURL('http://www.inclick.net');
  34.  
  35. $result = $user_manager->createPublisher($publisher_user,false);
  36. $user_manager_result = $result->getReturnValue();
  37.  
  38. if($result->getErrorCode())
  39. {
  40.     $manager_result = $result->getReturnValue();
  41.     $error_array = $manager_result->getFieldValidationErrors();
  42.     foreach ($error_array as $key => $value) {
  43.         echo "Error with Field \"$key\": $value<br />\n";
  44.     }
  45.     echo "Error Code: " . $result->getErrorCode() . ": ";
  46.     echo "" . $result->getErrorMessage() . "<br>";
  47. }
  48. else
  49. {
  50.     echo "Successfully created account ID " . $user_manager_result->getUserID() . "!";
  51. }
  52. ?>

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_PublisherUser.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);
$publisher_user = new IMG_PublisherUser();

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

$publisher_user->setFirstName('First');
$publisher_user->setLastName('Last');
$publisher_user->setTitle('Title of User');
$publisher_user->setCompany('inMotion Group');
$publisher_user->setAddress1('123 This Street');
$publisher_user->setAddress2('Suite 100');
$publisher_user->setCity('Troy');
$publisher_user->setState('MI');
$publisher_user->setPostalCode('48083');
$publisher_user->setCountry('USA');
$publisher_user->setPhoneNumber('248-616-1943');
$publisher_user->setUsername('publisher_name');
$publisher_user->setPassword('testing');
$publisher_user->setEmailAddress('publisher_email@inmotiongroup.com');
$publisher_user->setPaymentMethod('check');
$publisher_user->setWebsiteDescription('This is information about my site');
$publisher_user->setWebsiteURL('http://www.inclick.net');

Each $publisher_user->setXXXX corresponds to the data being stored. For example, $publisher_user->setFirstName is the first name of the account holder. 

$publisher_user->setCommissionRate($action_vars["network_base_commission"]/100);

This line sets the starting commission rate for the publisher. The $publisher_user->setCommissionRate() object expects the value to be in its raw from. For example, a commission rate of 35% is entered as "0.35". In this example, we obtained the default commission rate from the inClick Ad Server deployments configuration file (the globals.php require). Since the configuration file uses a whole number, we divide it by 100 to get the decimal equivalent. 

 
$result = $user_manager->createPublisher($publisher_user,false);
$user_manager_result = $result->getReturnValue();

These lines send the data to the ad server, processing the new publisher account request. If a failure occurs, the error code and corresponding error message are returned as objects:

$result->getErrorCode()
$result->getErrorMessage()

On a successful retrieval, the object values can be found within the following object:

$result->getReturnValue() 
if($result->getErrorCode())
{
    $manager_result = $result->getReturnValue();
    $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 account ID " . $user_manager_result->getUserID() . "!";
}

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

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