RevuCue API





OVERVIEW:


RevuCue’s API is currently designed to allow data from third party applications to be entered into a user’s account programmatically and start the review process based on the user's settings.

A third party application can be programmed to send customer data based on a trigger action or event and subsequently start the review process within RevuCue without the user being required to do any additional action beyond what they already currently perform.

Once the data is received and stored into the user's RevuCue account, all of their custom settings will automatically apply to the customer just entered, so all branding, custom emails, and time delay settings will automatically apply to the customer that was entered through the API.

If you have any questions after reading the following documentation, email mike@revucue.com.





Example Code (php):


          
            <?php
	    
            $call_url = 'https://app.revucue.com/api/customer/add';

            // prepare post data
            $post_fields = array(
                'api_key' => '< your_api_key >',
                'first_name' => 'Customer First Name',
                'last_name' => 'Customer Last Name',
                'email' => 'Customer Email',
                'company_name' => 'Customer Company Name',
                'phone_number' => 'Customer Phone Number',
                'addressline1' => 'Customer Address 1',
                'addressline2' => 'Customer Address 2',
                'city' => 'Customer City',
                'state' => 'Customer State',
                'zipcode' => 'Customer Zipcode',
                'notes' => 'Notes',
                'immediately' => 'true',
                'estimateddate' => '05/25/2016',
                'output_format' => 'json'
            );

            $create_query_string = http_build_query($post_fields, '', '&');

            //open connection
            $ch = curl_init();

            //set the url, number of POST vars, POST data, ssl check false, response read
            curl_setopt($ch, CURLOPT_URL, $call_url);
            curl_setopt($ch, CURLOPT_POST, count($post_fields));
            curl_setopt($ch, CURLOPT_POSTFIELDS, $create_query_string);
            curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
            curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);

            //execute post
            $result = curl_exec($ch);
            if ($result === false) {
                $info = curl_getinfo($curl);
                curl_close($curl);
                die('Error : ' . var_export($info));
            }

            //close connection
            curl_close($ch);

            //$response = new SimpleXMLElement($result);

            // For XML to array
            $response = json_decode($result, true);

            // For JSON to array
            print_r($response);

            ?>
          
        

Common required parameters to call API:

(Please note the only customer data required is their first name and email.)




Parameter Required or not Value Description
Api_key Required Located in your RevuCue portal Api key is mandatory for call to API

To add a new customer and start the review process use this base URL:



app.revucue.com/api/customer/add

Parameters:



Parameter Required or not Value Description
First_name Required Customer first name
Last_name Optional Customer last name
Email Required Customer email
Company_name Optional Customer company name
Phone_number Optional Customer phone number
Address line 1 Optional Customer address
Address line 2 Optional Customer address 2
City Optional Customer city
State Optional Customer state
Zipcode Optional Customer zipcode
Notes Optional Note
Estimated Date Optional (If it's on from form settings then required) Date Format (MM/DD/YYYY) Send email to customer on specific date
Immediately Optional (Only works if estimate date is on) True or false If set to true, send rating email now
Output_formal Optional JSON or XML (Default JSON) In which format output response