API Documentation


StartExam API is a REST HTTP web service.
StartExam API is publicly available on the domain https://api.startexam.com/ by HTTPS/SSL protocols and port 443.


StartExam API may be used by developer who is the owner or admin of a StartExam App account.
An authenticated request requires two headers: the Date and the Authorization header.

How to construct Authorization headers...


StartExam API returns specific HTTP status codes and either Json or Xml Content-Type responses based on a request HTTP header Accept

How to process Responses...


Action HTTP Request Description
Sync Employees

POST v1/employees

Syncs actual list of employees into StartExam. Employees are added or updated automatically using identifiers from the corporate system. Try Method
Create Test

POST v1/create-test

Creates a new empty test in StartExam. Try Method
Create or Update Program

POST v1/program

Creates or updates a program, its modules, tests and other settings in StartExam. Try Method
Register Program Employees

POST v1/program/employees

Registers employees for a program. Try Method
Register Participants

POST v1/participants

Registers test participants and returns their identifiers that can be used to start the test. Try Method
Get Participants Results

GET v1/participants?center={center}&from={from}&to={to}

Returns results of the test participants for the specified center and time range. Try Method
Get Participants Results

GET v1/participants?participantId={participantId}

Returns results of the test participants for the specified participant ids. Try Method
Get Session Report

GET v1/session?sessionId={sessionId}

Returns detailed report with test session results. Try Method