Display Assessments

Assessments are hosted on the domain 'suggestic.assessments.com.' To access them, you must pass the assessment's ID in base64 format as a URL parameter and include a user's JWT bearer token in the header.

Optionally, you may send a primary color hex value in the color key like this: https://assessments.suggestic.com/?assessmentId={{assessment.id}}&color={{hexcolor}}

Swift Header Example

let token = MSession.sharedInstance.session?.token {
headers["Authorization"] = "Bearer \(token)"

Anonymous User Scenario

For an anonymous user, you can include the 'onboarding' parameter in the URL as follows: https://assessments.suggestic.com/?assessmentId={{assessment.id}}&onboarding=true

In this scenario, the user's responses won't be stored on the website but will be returned to the container (browser, webview, etc) for management.

Styling and Customization

Style	Parameter	Description
Primary Color	color={{hexcolor}}	Hex color
Back Button	back_button=true	Enables display of the back button
Supplement Recommendatios Redirect	results_path={{path}}	Enables a redirect to a specific path for supplement recommendations

For additional styling, please reach out to [e-mail]

IFrame Use Case and Window Messages

If you're loading an assessment as an iFrame, the page will message the container when the assessment status changes.

Status	Description
complete	The user completed the assessment.
close	The user clicked on the close button.
exit	The user selected an answer that finishes the assessment before completion.

Please see a code example below.

  window.addEventListener('message', (event) => {
      if (event.origin.includes('assessments')) {
        const stringifiedResponse = event.data;
        const response = JSON.parse(stringifiedResponse);
        const { data } = response;
        const { status } = data;
        if (status === 'complete') {
          // quiz is finished
        }

        if (status === 'close') {
          // quiz was closed by the user
        }
      }
    });