How-To Guide: Installing Testimonials and Review widgets on your website using amp iframes.

1.Introduction

Welcome to the documentation for XAmplifier API. Here you will find all required details on our APIs, including technical concepts and formats, authentication methods, error codes and FAQs. The API provides access to features of our Business products available to clients using XAmplifier. The API is highly available and we are committed to their continued improvement and evolution.

2.The Business Unit concept

XAmplifier uses the business unit concept as the collection point for all XAmplifier content for a website. The business unit hosts a company’s rating, its reviews, and the company responses. A business unit has a unique ID, and is used throughout the APIs. A business unit refers to one main domain (primary name), and it can be associated with other domain names or sub-domains (referral names).

3.Figuring out your Business Unit ID

For almost any integration, the first step is getting your Business Unit ID. The Business Unit ID is a unique key to your domain. To find your Business Unit ID(s)- find the "Location" identifier code used in your data feed; Leave empty if you want to return the overall Rating Score for your entire organization and not the individual Business Units' scores.

4.Authentication

The API uses OAuth 2.0 authentication in order to access private resources. The API key will be provided by your XAmplifier account manager.

5.Schema

All API requests must be made over HTTPS. Empty values are included as null rather than omitted. All date/time responses are returned using ISO 8601 format using UTC.

6.Cache

Some results are cached on our API servers. Cached results will also include HTTP header information about client cache-ability.

7.How-To install an AMP iframe on your website’s homepage to display testimonials.

Classic Widget:

• Log in to your website hosting/building interface.

• Select your homepage and the section where you would want to display the testimonials.

• Copy the following code into the code-block section of your website building interface:

<iframe height="100%" id="demo-reviews-iframe" frameborder="0" style="width: 50%; padding: 0px; margin: 0px; border: 20px; display: block; height: 775px; overflow: hidden;" src="https://admin.xamplifier.com/reviews/classicWidget.cfm?businessUnit=[businessunit-ID]&amp;directlink=http://www.veintreatmentforum.com&amp;abbreviation=110&amp;reviewcount=10&amp;minScore=&amp;maxScore=&amp;link=1&amp;siteID=&amp;border=1&amp;borderRadius=20px&amp;borderColor=rgb(67,114,136)&amp;showStars=1&amp;showDate=1&amp;showScore=1&amp;reviewFont=arial&amp;reviewFontColor=black&amp;reviewFontSize=13px&amp;cmTitleFontColor=black&amp;cmTitleFont=arial&amp;cmTitleFontSize=13px&amp;showHeader=1&amp;customTitle=<left><br /><img src='http://admin.xamplifier.com/images/clientlogos/log_veinTreatmentForum.png'><br /><br><strong>VeinTreatmentForum.com</strong>&amp;apiKey=[API-KEY]"></iframe>

Note: Use the above code when you want to abbreviate the testimonials/reviews to 110 characters.

The output would look like:

And if you want to abbreviate your testimonials/reviews to just 40 characters, you’d need to change abbreviation=40 as shown below:

<iframe height="100%" id="demo-reviews-iframe" frameborder="0" style="width: 50%; padding: 0px; margin: 0px; border: 20px; display: block; height: 775px; overflow: hidden;" src="https://admin.xamplifier.com/reviews/classicWidget.cfm?businessUnit=[businessunit-ID]&amp;directlink=http://www.veintreatmentforum.com&amp;abbreviation=40&amp;reviewcount=10&amp;minScore=&amp;maxScore=&amp;link=1&amp;siteID=&amp;border=1&amp;borderRadius=20px&amp;borderColor=rgb(67,114,136)&amp;showStars=1&amp;showDate=1&amp;showScore=1&amp;reviewFont=arial&amp;reviewFontColor=black&amp;reviewFontSize=13px&amp;cmTitleFontColor=black&amp;cmTitleFont=arial&amp;cmTitleFontSize=13px&amp;showHeader=1&amp;customTitle=<left><br /><img src='http://admin.xamplifier.com/images/clientlogos/log_veinTreatmentForum.png'><br /><br><strong>VeinTreatmentForum.com</strong>&amp;apiKey=[API-KEY]"></iframe>

Important variables you would need to know about while implementing the above code:

API key: The API key will be specific to your company and will need to be included in the above code. It will be provided by your XAmplifier account manager.

BusinessUnit: The business unit controls which reviews are shown for specific locations.

The output would look like:

Horizontal Widget:

• Log in to your website hosting/building interface.

• Select your homepage and the section where you would want to display the testimonials.

• Copy the following code into the code-block section of your website building interface:

<iframe height="100%" id="demo-reviews-iframe" frameborder="0" style="width: 50%; padding: 0px; margin: 0px; border: 20px; display: block; height: 775px; overflow: hidden;" src="https://admin.xamplifier.com/reviews/classicWidget.cfm?businessUnit=[businessunit-ID]&amp;directlink=http://www.veintreatmentforum.com&amp;abbreviation=110&amp;reviewcount=10&amp;minScore=&amp;maxScore=&amp;link=1&amp;siteID=&amp;showStars=1&amp;showDate=1&amp;showScore=1&amp;reviewFont=arial&amp;reviewFontColor=black&amp;reviewFontSize=13px&amp;cmTitleFontColor=black&amp;cmTitleFont=arial&amp;cmTitleFontSize=13px&amp;showHeader=1&amp;customTitle=<left><br /><img src='http://admin.xamplifier.com/images/clientlogos/log_veinTreatmentForum.png'><br /><br><strong>VeinTreatmentForum.com</strong>&amp;apiKey=[API-KEY]"></iframe>

Note: Use the above code when you want to abbreviate the testimonials/reviews to 110 characters.

The output would look like:

And if you want to abbreviate your testimonials/reviews to just 40 characters, you’d need to change abbreviation=40 as shown below:

<div class="container-fluid">
<iframe width="100%" height="100%" id="demo-reviews-iframe" frameborder="0" style="width: 100%; padding: 0px; margin: 0px; border: 20px; display: block; height: 575px; overflow: hidden;" src="https://admin.xamplifier.com/reviews/horizontalWidget.cfm?clientLogo=http://admin.xamplifier.com/images/clientlogos/log_veinTreatmentForum.png&amp;directLink=http://www.veintreatmentforum.com&&amp;abbreviation=40&amp;reviewcount=10&amp;minScore=&amp;maxScore=&amp;link=1&amp;siteID=&amp;showStars=1&amp;showDate=1&amp;showScore=1&amp;reviewFont=arial&amp;reviewFontColor=black&amp;reviewFontSize=13px&amp;cmTitleFontColor=black&amp;cmTitleFont=arial&amp;cmTitleFontSize=13px&amp;showHeader=1&amp;customTitle=&amp;customTitleColor=rgb(67,114,136)&amp;buttonColor=rgb(67,114,136)&amp;apiKey=[API-KEY]"></iframe>
</div>

Note: Use the above code when you want to abbreviate the testimonials/reviews to 40 characters.

Embed reviews onto your website’s location page.

Use our sample code to embed reviews on your website’s location page.

To do so, you will have to :

• Copy the following sample of code that needs to be included on your location pages to include the review widget from XAmplifier.

• Change the BusinessUnit (i.e. the location ID you have assigned for all your   locations) in the code to change the location.

• A variety of parameters  can be altered in the widget code to change appearance (color, width, border, font, etc).  

Sample Code - (Classic) - Location Page Widget - Single Locations

<!DOCTYPE html>

<html>

<head>

   <meta charset="utf-8">

   <title>Classic Widget</title>

   <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">

   <link rel="stylesheet" type="text/css" href="https://admin.xamplifier.com/reviews/stylesheets/style.css">

   <link rel="stylesheet" type="text/css" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css">

   <link href='https://fonts.googleapis.com/css?family=Droid+Sans:400,700' rel='stylesheet' type='text/css'>

   <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>

   <script src="https://admin.xamplifier.com/reviews/js/responsiveiframe.js"></script>

   <script src='//maxcdn.bootstrapcdn.com/bootstrap/3.3.2/js/bootstrap.min.js'></script>

   <script>

       (function($){

           $(function(){

               $('#myIframe2').responsiveIframe({ xdomain: '*'});

           });

       })(jQuery);

   </script>


</head>

<body>



<div class="container-fluid">

<iframe height="100%" id="demo-reviews-iframe" frameborder="0" style="width: 50%; padding: 0px; margin: 0px; border: 20px; display: block; height: 775px; overflow: hidden;" src="https://admin.xamplifier.com/reviews/classicWidget.cfm?businessUnit=[businessunit-ID]&amp;directlink=http://www.veintreatmentforum.com&amp;abbreviation=40&amp;reviewcount=10&amp;minScore=&amp;maxScore=&amp;link=1&amp;siteID=&amp;border=1&amp;borderRadius=20px&amp;borderColor=rgb(67,114,136)&amp;showStars=1&amp;showDate=1&amp;showScore=1&amp;reviewFont=arial&amp;reviewFontColor=black&amp;reviewFontSize=13px&amp;cmTitleFontColor=black&amp;cmTitleFont=arial&amp;cmTitleFontSize=13px&amp;showHeader=1&amp;customTitle=<left><br /><img src='http://admin.xamplifier.com/images/clientlogos/log_veinTreatmentForum.png'><br /><br><strong>VeinTreatmentForum.com</strong>&amp;apiKey=[API-KEY]"></iframe>

</div>

</body>

</html>

Embed reviews onto you website’s homepage for all locations.

Use our sample code to embed reviews on your website’s homepage.

To do so, you will have to :

• Copy the following sample of code that needs to be included on your location pages to include the review widget from XAmplifier.

• Change the BusinessUnit in the code to change the location.

• A variety of parameters  can be altered in the widget code to change appearance (color, width, border, font, etc).  

 Sample Code - (Horizontal) - Home Page Widget - All Locations

<!doctype html>

<html>

<head>

<meta charset="utf-8">

<title>Horizontal reviews home widget</title>

<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">

<link rel="stylesheet" type="text/css" href="https://admin.xamplifier.com/reviews/theradome/css/style.css">

<link rel="stylesheet" type="text/css" href="//maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css"> 

<link href='https://fonts.googleapis.com/css?family=Droid+Sans:400,700' rel='stylesheet' type='text/css'>

<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>

<script src="https://admin.xamplifier.com/reviews/theradome/js/responsiveiframe.js"></script>

<script src='//maxcdn.bootstrapcdn.com/bootstrap/3.3.2/js/bootstrap.min.js'></script> 

<script>

 (function($){

     $(function(){

       $('#myIframe').responsiveIframe({ xdomain: '*'});

     });     

 })(jQuery);

</script>


</head>

<body>


<div class="container-fluid">

<iframe width="100%" height="100%" id="demo-reviews-iframe" frameborder="0" style="width: 100%; padding: 0px; margin: 0px; border: 20px; display: block; height: 575px; overflow: hidden;" 

src="https://admin.xamplifier.com/reviews/horizontalWidget.cfm?clientLogo=http://admin.xamplifier.com/images/clientlogos/log_veinTreatmentForum.png&amp;directLink=http://www.veintreatmentforum.com&&amp;abbreviation=40&amp;reviewcount=10&amp;minScore=&amp;maxScore=&amp;link=1&amp;siteID=&amp;showStars=1&amp;showDate=1&amp;showScore=1&amp;reviewFont=arial&amp;reviewFontColor=black&amp;reviewFontSize=13px&amp;cmTitleFontColor=black&amp;cmTitleFont=arial&amp;cmTitleFontSize=13px&amp;showHeader=1&amp;customTitle=&amp;customTitleColor=rgb(67,114,136)&amp;buttonColor=rgb(67,114,136)&amp;apiKey=[API-KEY]"></iframe>

</div>

</body>

</html>

 Variables Glossary