top of page

Welcome to your complete
Vroom widget integration guide 

Group 48095947.png
Group 48095949.png
Group 48095953.png

VROOM

What is it?

Vroom is a Javascript code snippet designed to easily integrate into a parent website.

 

Vroom works best when combined with parameters received from the host website to "pre fill" finance assumptions. The Vroom Widget will capture and validate customer application data and transfer this data into the Drive IQ system and lender portals. Validation is performed by calling a number of Lambda micro services and the Drive IQ matching engine. 

​

​​

INTEGRATION GUIDE

This guide is best for IT Administrators and Software Developers

In this guide you will find information on implementing the "Vroom Widget" (VW) solution into your website. 

​

Please note:

​

  1. This tool cannot be implemented in static websites
     

  2. In order for your preferred lender results and notification routing channels to be used, some additional configuration is required in Drive IQ. The IQ configuration requirements are not covered in this guide however, we would be happy to assist you by calling the IQ support team on 1300 301 720 or by lodging a support enquiry at the bottom of this page.

COLOURS

Vroom allows configurable colour combinations to best match the host website or brand. these colours are passed using parameters in the basic embedment code. 

<CODE>

Basic code is inserted into the website either as a "code snippet" or as an iframe.

The native size for iframe is 394px(w) x 740px(h)

PARAMETERS

the code paramters are mostly optional with the exception of lead origin information. In the event that certain parameters (such as purchase price) are unknown, Vroom will default to an "unknown" vehcile journey.

LENDERS

Lenders are configurable and can be simply sorted base don the customers preferences or, by using a controlled "waterfall" approach 

COLOURS

Select your brand colours

Tertiary Colour
Used for headings
(example: #2f2e2e)

Quaternary Colour
Used for secondary lheadings and labels (example: #605e5e)

Secondary Colour
Used for answer buttons, body text, tooltips, and tool tip message boxes.
(example: #a0a09f)

Primary Colour
Used for call to action buttons & progress bar.
(example: #cd1d1c)

CODE SNIPPET </script>

You need a widget code

Insert the provided widget code below in the front end web page where the widget is to be displayed. Provide it with the required (pink)  and optional (red)  parameters

​

Note: The VW can be integrated through either a code snippet or iframe (as required on WIX websites or where significant CSS conflicts are identified ). The iframe cut/paste code is shown in examples 3 and 4 further down the page.

​

​​

​

Example 1:  code integration

<div id="vroomroottag" style="width: 394px; min-height: 740px">
<script src="
https://demo-vroomcode.youxpowered.com.au/WIDGET_ID?PARAMATERS"></script>​

​

Example 2:  code integration

<div id="vroomroottag" style="width: 394px; min-height: 740px">
<script src="
https://demo-vroomcode.youxpowered.com.au/chery?nvic=0AV422&amount=60000"></script>​

iFRAME </iframe>

You need a widget code

Insert the provided widget code below in the front end web page where the widget is to be displayed. Provide it with the required (pink)  and optional (red)  parameters

​

Note: The native size for iframe is 394px(w) x 740px(h). The VW can be integrated through either a code snippet or iframe. Code Snippet cut/paste code is shown above in examples 1 and 2.

​

​​

​

Example 3:  code integration

<div style="width: 100%; height: 740px; display: flex; justify-content: center; align-items: center;">
  <div style="display: flex; justify-content: center; align-items: center; width: 100%;">
    <iframe src="
https://vroom.youxpowered.com.au/WIDGET_ID?PARAMETERS" style="box-shadow: 0px 10px 5px 0px rgba(0,0,0,0.25); border: 0.3px solid grey; width: 360px; border-radius: 15px; height: 740px;"></iframe>
  </div>
</div>

​

Example 4:  code integration

<div style="width: 100%; height: 740px; display: flex; justify-content: center; align-items: center;">
  <div style="display: flex; justify-content: center; align-items: center; width: 100%;">
    <iframe src="
https://vroom.youxpowered.com.au/iframe/chery?nvic=0AV422&amount=60000" style="border: 0.5px solid grey; width: 360px; border-radius: 15px; height: 740px;"></iframe>
  </div>
</div>

Vehicle Specific

Vehicle Specific

To effectivley retreive the correct glasse's value Vroom needs either the NVIC or VIN or buildYear, make, model, variant for every car.

 

If the car is NOT new, we also require kilometers. For every car, we also require the amount.

​

  • Unique every time:

    • Condition (new/used/demo)*

    • buildYear (yyyy)*

    • make 

    • model 

    • variant 

    • nvic

    • vin (17 digit only)

    • amount (no dollar sign required)*

    • kilometers 

PARAMETERS

What other parameters are there?

Let's have a look at this in more detail.

Please note; that the list of parameters will be updated over time to include additional functionality. Parameters marked with an * are mandatory 

Configuration for parameters is: &parameter_name=value

General Configuration

Generally constant every time - we can set your default values so you don't have to pass them unless you want to override your default for a specific vehicle.

​

  • dealerName*

  • dealerAccountNumber

  • abn*

  • email*

  • phone

  • leadEmail

  • primaryColor

  • secondaryColor

  • tertiaryColor

  • quaternaryColor

Finance Specific

Optional presets - you can set your default values or allow them to be selected by the user.

​

  • loanUsage - (personal/business)

  • loanType - (chattel_mortgage/ lease_rental)

  • loanTerm - (number between 1-7)

  • depositAmount - values > 0 accepted

  • tradeInAmount - values > 0 accepted

  • balloonPercentage - values > 0 and < 100 are accepted (no % sign needed)

Parameter
Mandatory or Optional
Accepted Input
Example
Notes
B
C
D
E
F
condition
O
range & text
condition=used
The condition of the vehicle
buildYear
O
number (YYYY)
buildYear=2020
The year provided here will be the built year of the vehicle.
make
O
text
make=mercedes
The manufacture make of the vehicle
model
O
text
model=c_class
the model of vehicle
variant
O
text
variant=200
the variant type fo the vehicle
nvic
O
text / number
nvic=CYXX23
the 6 digit Nevdis identificstion code
vin
O
number
vin=WPOZZZ93ZC0001234
17 digit vehicle identification number
amount
O
number
amount=99000
listed selling price (no dollar sign requried)
kilometers
O
number
kilometers=31200
Distance travelled by the asset in Killometers
dealerName*
O
text
dealerName*
Name of Vendor
dealerAccountNumber
O
text
dealerAccountNumber
The EC (Easycars) account number of the Vendor
abn*
O
number
abn
Australian Business Number of the Vendor
email*
O
email
email
Contact email of the Vendor
phone
O
number
phone
Contact Phone Number of the Vendor
leadEmail
O
email
leadEmail
A specific email for Leads to be sent to
primaryColor
O
text
primaryColor
The colour used for the main headding, buttons and slider
secondaryColor
O
text
secondaryColor
The colour used for the main body text within the applciation
tertiaryColor
O
text
tertiaryColor
The colour used for answers
quaternaryColor
O
text
quaternaryColor
The colour used for the background of the widget
loanUsage - (personal/business)
O
range & text
loanUsage=personal
whether the loan is for personal or business use. Value personal/business
loanType - (chattel_mortgage/ lease_rental)
O
text
loanType=chattel_mortgage
Type of finance facility. Values of chattel_mortgage/ lease_rental
loanTerm - (number between 1-7)
O
range & number
loanTerm=5
The term (duration) of the laon number between 1-7
depositAmount - values > 0 accepted
O
number
depositAmount=10000
A deposit amount on the loan values > 0 accepted and less than the loan amount
tradeInAmount - values > 0 accepted
O
number
tradeInAmount=20000
the trade in amount of an existing asset. Value >0 accepted and must be less than the loan amount
balloonPercentage - values > 0 and < 100 are accepted (no % sign needed)
O
range & number
balloonPercentage=30
a baloon or residual percentage applied to the loan - values > 0 and < 100 are accepted (no % sign needed)

LENDERS

Vroom is compatable with over 78 different lenders. In addition,  lender selection can be controlled using the propriatory "waterfall" system (optional).

Priority:

1

2

2

2

3

3

simply email us support@driveiq.com.au with your preffered list of lenders. (please include partner ID). To include a waterfall. please list lenders and their corrosponding prority order.

Lender:

Lender name 1

Lender name 2

Lender name 3

Lender name 4

Lender name 5

Lender name 6

DriveIQ-68-Lenders-Logos.png
bottom of page