Reevoo

The Reevoo Developer Hub

Welcome to the Reevoo developer hub. You'll find comprehensive guides and documentation to help you start working with Reevoo as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Overview

Badges are our way of displaying aggregated information about a product or brand. This information is summarised through an average score and the total number of reviews available. Consumers can access more detailed information and view specific reviews by opening a lightbox (modal window) or through the embedded widget.

Installation

  1. Include the Reevoo JavaScript library
  2. Add the reevoo-badge tag with your specific set of attributes

Examples

<reevoo-badge 
  type="product" 
  product-id="SKU"
></reevoo-badge>
<reevoo-badge 
  type="product" 
  product-id="series:group_identifier"
></reevoo-badge>
<reevoo-badge 
  type="brand"
  trkref="TRKREF"
></reevoo-badge>
<reevoo-badge 
  type="brand"
  score="customer_service" 
  trkref="TRKREF"
></reevoo-badge>
<reevoo-badge 
  type="brand" 
  branch-code="BRANCH_CODE"
></reevoo-badge>

Badge Types

  1. Brand Badges
  2. Product Badges
  3. Ask An Owner Badges
  4. Combo Badges (Product & Ask An Owner)

Configurable Attributes

Reevoo Widgets support the following list of attributes

Actions

Attribute Name

Accepted Values

Default Value

Description

click-action

no_action, open_lightbox, open_window

open_lightbox

Usually the click action for the specific badge variant is defined by Reevoo administrators. By default the lightbox will be opened.

  • click-action attribute gives you the ability to control the behaviour and overwrite the default setting.

on-click

Javascript code

In some cases you may want to implement your own logic for the click action. This attribute gives you ability to define your custom javascript function. This function will be evaluated when the user click on the badge, but after standard click action is executed.

Example: on-click="function(){ alert('badge clicked') }"

Examples

<reevoo-badge
  type="product" 
  product-id="SKU" 
  on-click="function(){ alert('badge clicked') }"
  click-action="no_action"
></reevoo-badge>
<reevoo-badge 
  type="product" 
  product-id="SKU" 
  click-action="open_lightbox"
></reevoo-badge>

Data Scope

Reevoo Widgets supports the following list of attributes that allows to scope the data:
Generic attributes
Automotive specific attributes

Mandatory attributes: product-id or manufacturer and model combination

Examples

<reevoo-badge
  type="product"
  manufacturer="ford"
  model="fiesta"
  model-variant="SE"
  model-year="2016"
  body-type="hatchback"
  used="0"
  engine-type="diesel"
  locale="en-GB"
></reevoo-badge>
<reevoo-badge 
  type="product" 
  product-id="SKU" 
></reevoo-badge>

Managed Badges

There are two ways of managing the look and feel of the badges

  1. Managed by Reevoo
  2. Self Managed

Managed by Reevoo

By specifying the "type" attribute or "type" and "variant" combination.
The Reevoo administrator is able to control the Badge look and feel you see, without you having to make any further code changes.

Self Managed

By specifying the "name" attribute, you can select the specific badge you will see.

The full list of supported badge names is available here

Updated 2 months ago

Badges


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.