If your application or tool requires notification when the Universal Proctoring Session is terminated, your application can leverage the following API to get a callback after the rating is generated and get the proview rating using the session UUID.
Termination Callback
The client needs to share a POST endpoint URL to receive a callback from the Proview Service.
Endpoint: To be shared by the client
Method: POST
Important: The Proview service will send a callback to the client system once the Universal Proctoring Session is Terminated.
Session Details
Get the Terminated Session details based on the session UUID.
Endpoint:
Development Environment - https://proview-universal.talview.dev/v1/sessions/<session_uuid>
Staging Environment - https://proctoring-staging.talview.com/v1/sessions/<session_uuid>
Production Environment - https://proctoring.talview.com/ v1/sessions/<session_uuid>
Method: GET
Important: session_uuid will be available in the body of the request sent by the Proview service to the callback URL.
API Contract
Authorization
For generating the access token, the below API will be used.
Owner | Talview | ||
Method | POST | ||
URL | Development Environment - https://auth.talview.dev/v1/user/login | ||
Request Schema: | |||
Parameter | Type | Mandatory | Description |
username | String | true | Email of the user with Test Admin role |
password | String | true | Password of the user with Test Admin role |
Sample Request | |||
{ "username": "example@gmail.com", "password": "abc12345" } | |||
Sample Response | |||
{ "access_token": "eyJhbGciO..........gQy40HdJ4", "refresh_token": "eyJhbGciO...........93vhs4D_8", "grant_type": "Bearer", "expires_in": 10800 } | |||
Important: Username and Password are Proview test-admin credentials
1. Proview Callback
Description | Receive callback from Proview service once the rating for a candidate is calculated. | ||
Owner | Client | ||
Method | POST | ||
URL | To be shared | ||
Request Schema: | |||
Parameter | Type | Mandatory | Description |
session_uuid | String | true | A universally unique identifier of the Session in the Proview service. |
| external_id | String | true | Session external id |
message | String | true | Message for Session Termination. |
Sample Request | |||
{ "message": "Session Has Been Terminated", "external_id": "5506693", "session_uuid": "f46bd560-53f6-11eb-b441-492a960aa0ba" } | |||
Once callback request is received third party service must use get-rating API to get the rating.
2. Get Proview Rating
Step 1 - Get the access token using test admin credentials and the above-mentioned API.
Step 2 - The access token generated must be sent with the get Proview rating API request in the Authorization header along with the app-id.
Note - app-id will be white-listed and shared by the Talview team.
Sample |
headers: { "Authorization": "Bearer <<access_token>>, "app-id": "<<app-id>>", } |
Description | Get the Session Details based on the session UUID. |
Owner | Talview |
Method | GET |
URL | Development Environment - https://proview-universal.talview.dev/v1/sessions/<session_uuid> |
Sample Response | |
{ "id": 188, "uuid": "f46bd560-53f6-11eb-b441-492a960aa0ba", "title": "Test assessment", "external_id": "testSession4", "type": "ai_proctor", "final_rating": "high", "status": "completed", "video_stream_url": null, "attendee_id": 4042, "proctor_event_id": null, "session_started_at": "2022-05-05T11:38:26.231Z", "system_info": { "ip": "43.224.156.196", "browser": "Chrome", "os": "Linux" } } | |