Confirmit API Integration guide

STEP 1

Add the redirect link for concept sauce in a script tag.

The redirect should look like the below:

Redirect("https://survey.rose.conceptsauce.io?param_id=PRMS01G3H5QXCJ252E6FK650KEGB0Y&respondent_id=" + CurrentID() + "&link=" + link, true);

param_id: is the unique shelf ID, concept sauce will provide you with unique param_id for each shelf
respondent_id: is used to pass the unique ID for each respondent, must contain only numbers, no special symbols
CurrentID(): holds the unique ID in Confirmit system once the respondent enters the link
link: this is a variable that holds the invite link for the survey, it is used to redirect the respondent back to the survey, see details below:

var link = encodeURIComponent(GetRespondentUrl('ReturnP'));

ReturnP: this is the info page that the respondent lands once returned from the shelf, all data captured and appended into the hidden variables must be on a same page so you can recode it from the API

if (!IsInRdgMode()) {

    var link = encodeURIComponent(GetRespondentUrl('LandingLabel'));

    Redirect("https://survey.rose.conceptsauce.io?param_id=XXXXXXX&respondent_id=" + CurrentID() + "&link=" + link, true);

}

STEP 2

API integration:

Inside the info page that the respondents returns write the javascript code in the Javascript tab.

You can find the information about each API Call at - https://conceptsauce.atlassian.net/wiki/spaces/API/pages/2652930049

Please do not forget to add another step to retrieve the respondent_encoded, this is a new method for the API that has been added. More info on this here: https://conceptsauce.atlassian.net/wiki/spaces/API/pages/2726920193

STEP 2.1

Get the survey ID from ParamID, Check if Api call was successful

STEP 2.2

Get shelf summary purchases and append the data into the hidden variables

STEP 2.3

Get the shelf details and append them into the hidden variables

STEP 2.4

Get the shelf details and append them into the hidden variables

STEP 2.5

Creating the object that will pass the selected favorite to be grayed out:

STEP 2.5.1

Pass the selection in the redirect link

SIP-API