Documentation · API

Run Your First REST Integration

Provision, authorize, launch, submit and retrieve a result.

Verified
Purpose
Provision, authorize, launch, submit and retrieve a result.
Prerequisites
  • Administrator access to both applications
  • Server-side secret storage
Architecture
Integration Studio represents the external client or LMS. API Exams App represents the assessment provider. Exam Player is the candidate-facing browser application.

Configuration

Technical flowPOST /webapi/auth/login → Bearer → /webapi/users → /webapi/tests → /webapi/authorizations → /candidate/launches → result

Implementation steps

  1. 01Activate REST-Only Integration in Provider Lab.
  2. 02Provision a candidate.
  3. 03Discover an assessment through /webapi/tests.
  4. 04Authorize the candidate through /webapi/authorizations.
  5. 05Create a launch and open Exam Player.
  6. 06Answer and submit.
  7. 07Inspect the webhook or pull result.

Testing procedure

  • Candidate, authorization, attempt and result are visible
  • The result contains score and pass/fail

Troubleshooting

Launch denied

Check candidate, active assessment, current authorization and scenario access rules.