Sample Applications

<?php
/*
* This script uses the Rezora Agent API to add a new contact entry to an agent's account, 
* and to add that contact to a specified Distribution List so that newly added contacts
* may be easily identified by the agent from within the Rezora system.
* See http://api.rezora.com/ for the full API documentation.
*/
 
// Set some configuration constants.
// Your Agent API Key username and password are available on your Rezora My Account page.
define('API_USERNAME', 'YOUR_API_USERNAME');
define('API_PASSWORD', 'YOUR_API_PASSWORD');
define('API_BASEURI', 'http://api.rezora.com/v1/');
define('API_FORMAT', 'application/json');
 
// Set the ID of the distribution list to which new contacts will be added.
// You should create a distribution list (called something like "Website Signup") exclusively for this purpose.
// You can get the ID of a lsit by using the Lists API Resource, or by noting the ID in the HTML code on the agent's Contacts page within the Rezora system.
// Leave the value as zero to skip this step (not recommended).
$intListID = 0;
 
// Validate the user-submitted form data before proceding
if (validateUserData()) {
  // First, we'll be posting data to the contacts collection resource to create a new contact.
  // Set some configuration variables specific to the task at hand.
  $strResource = 'contacts';
  $strData = '{
    "data":{
      "contact_name":"' . $_POST['name'] . '",
      "contact_email":"' . $_POST['email'] . '"
    }
  }';
 
  // Post the API request
  $arrResponse = doAPIPost($strResource, $strData);
 
  // Make sure we successfully added the contact before continuing
  if ($intListID > 0 && $arrResponse['status'] == 200) {
    // Next, we'll be posting data to the lists/ID/contacts collection resource to associate the new contact with the specified distribution list.
    // Set some configuration variables specific to the task at hand.
    $strResource = 'lists/' . $intListID . '/contacts';
    $strData = '{
      "data":{
        "contact_id":"' . $arrResponse['body'][0]->contact_id . '"
      }
    }';
 
    // Post the API request
    $arrResponse = doAPIPost($strResource, $strData);
  }
 
  // Get a status message to diplay to the user.
  $strMessage = getStatusMessage($arrResponse['status']);
} else {
  // Send a message to the user explaining wehat they have done wrong.
  // Your validateUserData() function should probably provide detailed error messages.
  $strMessage = 'You must provide valid information. Please try again.';
}
 
// Function for validating the user-submitted form data
function validateUserData() {
  // You'll probably want to put some code here to validate whatever input you're receiving from the user.
  return true;
}
 
// Make an API POST request
function doAPIPost($strResourcePath, $strData) {
  // Open a cURL resource
  $ch = curl_init();
 
  // Set the necessary parameters
  curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
  curl_setopt($ch, CURLOPT_USERPWD, API_USERNAME . ':' . API_PASSWORD);
  curl_setopt($ch, CURLOPT_URL, API_BASEURI . $strResourcePath);
  curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . API_FORMAT, 'Content-type: ' . API_FORMAT));
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
 
  // Make this a POST request
  curl_setopt($ch, CURLOPT_POST, true);
  curl_setopt($ch, CURLOPT_POSTFIELDS, $strData);
 
  // Make the request and capture the response and status code.
  $arrResponse['body'] = json_decode(curl_exec($ch));
  $arrResponse['status'] = curl_getinfo($ch, CURLINFO_HTTP_CODE);
 
  // Close the cURL resource
  curl_close($ch);
 
  return $arrResponse;
}
 
// Return a status message to display to the user.
function getStatusMessage($strStatus) {
  // An array of all status codes.
  // These descriptions are rather technical. You may want to make them more user-friendly for production.
  $arrStatuses = array(
    '200' => 'The request was successfully processed.',
    '204' => 'The request was formatted correctly, but no data was found for the specified resource.',
    '400' => 'Your data has failed a validation test.',
    '401' => 'Either your username or password are incorrect, or you are attempting to access a resource that is not available for your user type.',
    '404' => 'The resource you have requested does not exist.',
    '405' => 'The method you are attempting to use (GET, POST, PUT, or DELETE) is not allowed for the resource you have requested.',
    '500' => 'The API experienced an internal error while attempting to process your request.',
    '501' => 'The method you are attempting to use (GET, POST, PUT, or DELETE) has not yet been implemented, but may be in a future release.'
  );
  // Look up the message that corresponds to the status code
  if (array_key_exists($strStatus, $arrStatuses)) {
    $strMessage = $arrStatuses[$strStatus];
  } else {
    // Use a default message if no match was found
    $strMessage = 'An unknown error occurred while attempting to add your information. Please try again.';
  }
  return $strMessage;
}
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Rezora API Sample: Add a Contact</title>
  </head>
  <body>
    <?php echo $strMessage ?>
  </body>
</html>