Versions Compared

Old Version 5

changes.mady.by.user Abs Chamali

Saved on

compared with

New Version Current

changes.mady.by.user abs chamali

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

STEP 1

Add the below 2 urls in the api.txt file, located in the company directory (selfserve/XXX)
(requires shell access, the Forsta support team can do it, too):
better-params-api.rose.conceptsauce.io
public-survey-data-api.rose.conceptsauce.io
Knowledge base link - https://decipher.zendesk.com/hc/en-us/articles/360010277973-Generic-API-Call

...

Code Block
languagexml
<var name="param_id" required="1"/>
<var name="respondent_id" unique="1"/>

STEP 3

Add the below code to your survey:

Add the below code to your survey: <exec cond="not gv.isSST()">
Code Block
languagexml
Info

In order to successfully do the API call - we're parsing some symbols away from the JSON object so the system accepts it, the symbols ' and *

If any of these symbols is used in either the param_id or respondent_id variables - it will not return the correct result from the API call.

For example - instead of using respondent_id test123*/test123' it should just be test123

STEP 3

Add the below code to your survey:

Code Block
languagexml
Add the below code to your survey:
<exec cond="not gv.isSST()">
surveyDir = "https://XXXX.XXXX.com/survey/%(first)s?state=[state]" % {"first": gv.survey.path}
redirectTarget = "https://survey.rose.conceptsauce.io/?param_id=%(first)s&amp;respondent_id=%(second)s&amp;link=%(third)s" % {"first": param_id, "second": respondent_id, "third": surveyDir}

The survey url, the XXXX parts should be replaced with yours (could be seen by opening the survey)

STEP 3 + base64 options

Base64 options. Add the below code to your survey:

Code Block
languagexml
disableProds = {
	"shelf": {
	"set:disabled_products": [
		"Product SKU CODE",
		"Product SKU CODE"
	]
	}
}

findDisabledProds = "&amp;custom_params=" + str(disableProds).replace("'",'"').replace(" ","").encode("base64").replace("\n","").replace("\t","")

surveyDir = "https://XXXX.XXXX.com/survey/%(first)s?state=[state]" % {"first": gv.survey.path}
redirectTarget = "https://survey.rose.conceptsauce.io/?param_id=%(first)s&amp;respondent_id=%(second)s&amp;link=%(third)s%(disableProds)s" % {"first": param_id, "second": respondent_id, "third": surveyDir, "disableProds": findDisabledProds}

The survey url, the XXXX parts should be replaced with yours (could be seen by opening the survey)be seen by opening the survey)

Make sure you change Product SKU CODE to the product code that is used in the shelf. Add as many as you need.

STEP 4

Redirecting:

Code Block
suspendExternal(redirectTarget)
</exec>

...

Code Block
<textarea 
  label="apiRequest_1"
  where="execute,survey,report">
  <title>hidden: api request 1</title>
  <exec>
createJson = {
	"event_type": "params_crud",
	"action": "get_params",
	"data": {
		"params_id": param_id
	}
}
thisQuestion.val = str(createJson).replace("'",'*').replace('*','"')
  </exec>
</textarea>

<suspend/>
Info

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:Basic API calls

STEP 6

The first API request, using Decipher’s build in logic node:

...