Result Link Integration Data Format and URL Parameters

We offer advanced integration to third party web services (such as a a company's internal CRM application) to customers who purchase our Premium subscription or higher.

Here is a brief description on how the integration is done: You can configure an integration URL (RESULT LINK) on your web server or Zapier where the test results will be sent to. When an applicant completes the typing test, our service will immediately create an http request to the URL you provided with the test results in the query string.

The test results will be sent in the following format:
http://$YOUR_INTEGRATION_URL$?firstname=$FIRSTNAME$&lastname=$LASTNAME$&email=$EMAIL$&custom1=$INFO1$&custom2=$INFO2$&title=$TESTTITLE$&text=$TESTNAME$&date=$DATE$&duration=$INCOMPLETE$$FDURATION&status=$STATUS$&keystrokesg=$GHITS$keystrokesn=$NHITS$&gross=$GUPM$&units=$UNITLABEL$&errors=$ERRORS$&accuracy=$ACCURANCY$&netspeed=$NUPM$

You can create a simple server side script page to get the values you need from the query string to your database.

-----------------------
Result integration
-----------------------

Once you have set up your account, log into the account as an Administrator. Click on the "Account Settings" -tab and scroll down to the "Advanced settings" -section.

In the Exit Link -setting, enter a URL test takers should be taken to after they have completed the test (for example http://www.yourserver.com/congratulations.html).

Then set the Integration setting to Enabled.

In the Result Link -setting enter in the URL that should be called to process the results (for example http://www.myserver.com/resultsaver.php)

Finally click on the Save changes button.

When the test taker has completed the test, our server will automatically call the the Result Link URL with all the information passed as URLEncoded GET parameters.

Here is an example call:
https://www.myserver.com/resultsaver.php?firstname=tuomas&lastname=tanner&email=tuomas.tanner%40typingmaster.com&custom1=111&custom2=222&title=Standard+Typing+Test&text=Fishing+in+Finland&date=8%2F31%2F2009+8%3A45+AM&duration=01%3A00&status=Passed&keystrokesg=332keystrokesn=322&gross=66&units=wpm&errors=2&accuracy=96&netspeed=64

You can use the simple tools built in to any server side language to read this data - the data will be automatically decoded correctly by most web frameworks. For example in PHP you can use the following $_GET["netspeed"]. With Java Servlets you can use Request.getParameter("netspeed).

After saving the results, the user will then be taken to the http://www.yourserver.com/congratulations.html. The user will not see the resultsaver.php page or know of its existence in any form.

-----------------------
Automatic login
-----------------------

You can use a special url to automatically have students log in and be taken to the test. When this login is used, no information is asked from the user, it is all provided in the link. No set up is necessary for this link. You can use the following automatic login url as the src parameter of an iframe for example, or just have it as a simple link for users to click on:

https://app.typingtestpro.com/test?id=yourtestid&test=1&autologin=1&email=[e-mail]&firstname=john&lastname=doe&customfield1=111&customfield2=222

The testid parameter specifies which test you wish to launch for the user.  If this link is used for a user the first time, it will automatically create a new user and add the additional information to the users data. If there already exists a user with the same email, the additional information will be update for that user.

You can use the customfield1 and customfield2 parameters to send special information about the user. For example a user id can be passed. Both of these fields will be passed to the Integration URL after the test so they can be saved in a database. This can also be used as an authentication method to prevent users from forging results. You could create a one time secure hash at the start of the test and add that as the customfield2. When the results are saved, you can compare the data from the Integration URL to the secure hash you have for that user to verify the authenticity of the results.

We have now added two different exit links you can direct your test takers to after the test, depending on the pass & fail status of the test. These settings can be found by logging in as an administrator and selecting the "Account Settings" -tab.

For the test takers that pass, you can create a page on your web site telling the next steps to take in the application process.