Pular para o conteúdo principal

FV Decipher Support

Todos os tópicos, recursos necessários para FV Decipher.

Base de Conhecimento da FocusVision

Virtual Incentives Integration

This document details the process for integrating Virtual Incentives to a survey using the Logic Library.

Overview

With the Virtual Incentives Rest API integration, we have the ability to offer incentives to respondents in real time. Incentive amount and type can be adjusted midfield via the API. The integration is implemented using the incentive logic node from the Logic Library. Please see the API programming instructions below.

The ProgramID (project number) and SKU (type of incentive) will be required for each project. Contact our support team or your Account Manager for these details.

1: Logic Syntax

The incentive logic node allows for real-time ordering of prepaid gift cards through the Virtual Incentives Rest API. To use the Virtual Incentives logic node, add the following <logic> tag to your survey:

Note: Usage of the incentive logic node requires an account with virtual incentives and configuring the IP address from where the request will originate.

<logic label="incentive"
uses="incentive.1"
incentive:userid="userid"
incentive:token="token"
incentive:programid="programid"
incentive:clientid="${source}"
incentive:sku="sku"
incentive:amount="5.00" />

<html label="giftcard_ok" cond="incentive.status == 200">
Here is your giftcard link ${incentive.r["order"]["accounts"][0]["link"]} </html>

2: Parameters

2.1: Required Attributes

The following attributes are required when using the incentive logic node:

incentive:userid

This is your Virtual Incentives account user ID.

incentive:token

This is your Virtual Incentives account token.

Note: It is highly recommended that you encrypt the token value, making it usable only within a company or survey. To encrypt your virtual incentive token, visit the following link, replacing <your-server> with your server domain, and <survey> with your survey path: https://your-server/apps/logic/survey:debug. Then, instead of adding the raw token value simply replace it with the encrypted value: incentive:token=”<encrypted value>”.

incentive:programid

A unique project number Virtual Incentives will assign to your project.

incentive:clientid

Client provided unique identifier for order, often a source variable is piped in here.

incentive:sku

Virtual Incentive assigns each type of incentive (e.g., Amazon.com gift code, Visa gift code, Target gift code…) with a SKU number. This identifies the type of incentive being fulfilled.

incentive:amount

Virtual prepaid denomination requested. This should not contain a currency symbol.

incentive:firstname

Incentive recipient first name.

Note: This field is displayed in the email and VRC salutation If this value is not specified it defaults to “Reward”.

incentive:lastname

Incentive recipient last name. If not specified it defaults to “Participant”.

incentive:email

Incentive recipient email address. If this value is not specified, it defaults to support@virtualrewardcenter.com.

 

2.2: Optional Attributes

The following attributes are optional, and will be used in the request payload:
 

incentive:address1

Incentive recipient address line 1

incentive:address2

Incentive recipient address line 2

incentive:city

Incentive recipient city

incentive:state

Incentive recipient state (2 character abbreviation)

incentive:zip

Incentive recipient zip

incentive:country

Incentive recipient country (2 character abbreviation)

incentive:udf1

User Defined Field to associate with incentive recipient

incentive:udf2

User Defined Field to associate with incentive recipient

 

To view a full log of each incentive request status/response per uuid, visit the following link, replacing <your-server> with your server domain, <survey> with your survey path and <xxxx> with the label for your incentive logic node:  

https://your-server/apps/logic/survey:debug?label=xxxx     

3: Piping Variables

You can pipe in values using the ${variable} syntax or the [variable] syntax for any incentive field. For example:

  • incentive:lastname="${lname}")

  • incentive:lastname="[lname]")

You can check that the correct value was piped in using the following link, where <your-server> is your server name, and <survey> is your survey path:

https://your-server/apps/logic/survey:debug

4: Customizing Error Messages

If an error occurs the respondent is not allowed to continue in the survey and is shown the default error message, "Something went wrong with getting your gift card. Please contact support." The error message can be customized using incentive:error, with the alternate message included in quotes:

incentive:error="custom error message"
  • Este artigo foi útil?