Code Examples
From API Documentation
Below are examples of how to access the API using PHP. These examples demonstrate a variety of available methods and content formats. While we do not cover every possible use of the API here, these examples meant to be indicative of all API calls.
All examples use the cURL library for handling the HTTP request. There are other methods available in PHP (and other languages, of course), and any means that allows you to send and receive the properly formatted requests and responses is perfectly acceptable.
Example 1: read the agents collection resource
<?php // Set some universal configuration variables. These will be // the same for all your API requests for a particular account. $strUsername = 'YOUR_USERNAME'; $strPassword = 'YOUR_PASSWORD'; $strBaseURI = 'http://api.rezora.com/v1/'; // Set some configuration variables specific to the task at hand. // In this example, we'll be reading data from the agents collection // resource. We'll retrieve the data in text format. $strResourcePath = 'agents'; $strRequestFormat = 'text/plain'; $strResponseFormat = 'text/plain'; // Open a cURL resource $ch = curl_init(); // Set the necessary parameters curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST); curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword); curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath); curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat)); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // Make the request and output the response. echo curl_exec($ch); // Close the cURL resource curl_close($ch); ?>
Example 2: read the agents/ID resource
<?php // Set some universal configuration variables. These will be // the same for all your API requests for a particular account. $strUsername = 'YOUR_USERNAME'; $strPassword = 'YOUR_PASSWORD'; $strBaseURI = 'http://api.rezora.com/v1/'; // Set some configuration variables specific to the task at hand. // In this example, we'll be reading data from the resource for // an agent with the ID 1234. We'll retrieve the data in XML format. // Notice that the presence of the .xml extension will override the // Accept header value ($strRresponseFormat). Alternatively, you // could leave off the extension and set the Accept header value // ($strRresponseFormat) to application/xml. $strResourcePath = 'agents/1234.xml'; $strRequestFormat = 'text/plain'; $strResponseFormat = 'text/plain'; // Open a cURL resource $ch = curl_init(); // Set the necessary parameters curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST); curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword); curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath); curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat)); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // Make the request and output the response. echo curl_exec($ch); // Close the cURL resource curl_close($ch); ?>
Example 3: post a new contact to the contacts collection resource
<?php // Set some universal configuration variables. These will be // the same for all your API requests for a particular account. $strUsername = 'hmorgan'; $strPassword = 'd7720f94da2080e4168ed2664356b8ba1ffbfb17'; $strBaseURI = 'http://api.rezora.com/v1/'; // Set some configuration variables specific to the task at hand. // In this example, we'll be posting data to the contacts collection // resource to create a new contact. We'll post data in JSON format, // and retrieve data in XML format. $strResourcePath = 'contacts'; $strRequestFormat = 'application/xml'; $strResponseFormat = 'application/json'; $strData = '{ "data":{ "contact_name":"Jane Smith", "contact_email":"jane.smith@company.com", "contact_type":"Active", "contact_title":"Consultant", "contact_company":"Acme Consulting", "contact_phone_home":"303-555-1234", "contact_phone_work":"303-555-1235", "contact_phone_mobile":"303-555-1236", "contact_phone_fax":"303-555-1237", "contact_business_street":"123 Church Street", "contact_business_street2":"Suite 12", "contact_business_city":"Shady Acres", "contact_business_state":"CO", "contact_business_zip":"12345", "contact_home_street":"124 Church Street", "contact_home_street2":"", "contact_home_city":"Shady Acres", "contact_home_state":"CO", "contact_home_zip":"12345" } } '; // Open a cURL resource $ch = curl_init(); // Set the necessary parameters curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST); curl_setopt($ch, CURLOPT_USERPWD, $strUsername . ':' . $strPassword); curl_setopt($ch, CURLOPT_URL, $strBaseURI . $strResourcePath); curl_setopt($ch, CURLOPT_HTTPHEADER, array ('Accept: ' . $strResponseFormat, 'Content-type: ' . $strRequestFormat)); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, $strData); // Make the request and output the response. echo curl_exec($ch); // Close the cURL resource curl_close($ch); ?>
