These API allow you to interach with PEAKS Profile to:

- retrieve questionnaires
- submit personality assessments
- retrieve PEAKS Reports (in PDF)
- retrieve PEAKS Data (raw format in XML)

- create and update user data


Once you signed up for the API you have received a user id and a password.


Before using the API, please let us know the IP address of the server that where the API is going to be consumed so that we will open the access on our backend.


Once this is set, the first step is to generate a security token that will be used in app the API calls.


Once you have the token, this is the usual process:


1) Create a User ID


Create a user id and password for the user you want to submit the assessment for.


2) Request a Questionnaire


According to the type of profile, you will be able to request the related questionnaire that you will be then use to show to your user


3) Submit the data to the server


Once you have captured the user's questionnaire submission, you will need to submit to our servers to be processed.

 


Once the data has been submitted, whenever you need, you can generate a report in PDF format or, extract the personality data.

Created with the Personal Edition of HelpNDoc: Create help files for the Qt Help Framework