- Purpose
- Beginner setup for the complete reference integration.
- 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
| Examples only | Studio https://studio.example.com · API https://api.exams.example.com · Exam Player https://exams.example.com |
| REST username/password | Must match the API Exams Integration Client; these are not browser admin credentials |
Implementation steps
- 01Open API Exams App, sign in as its browser administrator, and open Integration Clients.
- 02Select or create the Integration Studio client. Under REST, enter a machine username and secret.
- 03Open Integration Studio → Connections → the API Exams connection.
- 04Enter the Provider Base API URL, for example https://api.exams.example.com. This is the API server, not Exam Player.
- 05Enter the Exam Player URL, for example https://exams.example.com.
- 06In Connections → REST API, enter the same REST username and secret configured in API Exams → Integration Clients → REST.
- 07Click Test Connection. Connected proves reachability, not simulator administration, SSO, webhooks or LTI.
Testing procedure
- Connection reports Connected
- REST login returns a bearer token
- A candidate can be provisioned and launched
Troubleshooting
Connected but scenario fails
Check REST credentials, simulator-admin variables, webhook settings, SSO registration and LTI registration independently.
REST 401
Compare Studio Connections → REST API with API Exams → Integration Clients → REST.