Testinvite offers a REST API system for clients to integrate our system into theirs and automate the workflow.
The REST API services include the following:
To authenticate requests to the API, include your organization's authorization token in the Authorization header of each HTTP request. You can find your unique token on your organization's page. Use the following format:
Ensure the token is kept secure, as it provides access to your organization's data.
Please find below the endpoints for the REST API service. The root for the endpoints is https://www.testinvite.com.
| Resource | Purpose | Route | HTTP Method | Documentation |
| Tasks | Fetch multiple tasks | GET | Click | |
| Fetch one task by its id | /api/integration/rest/v1/tasks/:id | GET | Click | |
| Fetch one task by its id and get additional details | /api/integration/rest/v1/tasks/:id/query | POST | Click | |
| Tests | Fetch multiple tests | /api/integration/rest/v1/tests | GET | Click |
| Fetch one test by its id | /api/integration/rest/v1/tests/:id | GET | Click | |
| Fetch one test by its id and get additional details | /api/integration/rest/v1/tests/:id/query | POST | Click | |
| Users | Fetch multiple users | /api/integration/rest/v1/users | GET | Click |
| Fetch one user by its id | /api/integration/rest/v1/users/:id | GET | Click | |
| Test instances | Fetch multiple test instances | /api/integration/rest/v1/test-instances | GET | Click |
| Fetch one test instance by its id | /api/integration/rest/v1/test-instances/:id | GET | Click | |
| Fetch one test instance by its id and get additional details | /api/integration/rest/v1/test-instances/:id/query | POST | Click | |
| Fetch proctoring evidences of a test session | /api/integration/rest/v1/test-instances/:id/proctoring-evidences | GET | Click | |
| Candidates | Fetch one candidate by its id | /api/integration/rest/v1/tickets/:id | GET | Click |
| Create a candidate under a task | /api/integration/rest/v1/tickets | POST | Click |
