Weergeven als Markdown

Launchpad

POST/v2/live/launchpad
Basis-URL
https://us1.proctorapi.com
Beschikbare regio's10 regio's
Maakt een proctor Launchpad-URL aan.
application/json

Body

Het proctor-verzoek om een proctor Launchpad-URL aan te maken.

user_id
stringVereist
Moet een alfanumerieke waarde bevatten (koppeltekens zijn ook acceptabel), uniek voor deze specifieke gebruiker.
Format should match: ^[a-zA-Z0-9-]*$.
exam_roster
stringVereist
Examenlijst-endpoint. Bevat een lijst van exam_name(s), exam_tag(s), section_id(s) en optionele roster_url.
roster_url
string

Roster-endpoint-URL. HTTP-methode: GET. Het antwoord moet een JSON-gestringificeerde array zijn. Bijvoorbeeld: '[["id1","name1"],["id2","name2"]]'

De waarde van "id" moet overeenkomen met de parameter "userId", uniek zijn voor de kandidaat en niet-herhalend binnen de roster.

Het roster-endpoint wordt gevalideerd door Proctorio, wat betekent dat als een ongeldig endpoint wordt opgegeven of als "userId" niet overeenkomt met een "id"-waarde in de array, de pogingen als "Unmatched" worden gemarkeerd in het Review Center.

De roster_url wordt alleen opgehaald door de eindgebruiker die het Review Center of de examenovereenkomstpagina bezoekt, aan de clientzijde, niet door Proctorio direct. Dit betekent dat het kan worden beveiligd met de sessie voor die specifieke gebruiker. Dit is opzettelijk, en als zodanig is het niet nodig dat de PII op enig moment aan Proctorio wordt doorgegeven, of het nu een Candidate Launch-verzoek of een Reviewer Launch-verzoek betreft.

expire
integer(int32)
Aantal seconden voordat de proctor-URL niet meer geldig is. De standaardwaarde voor deze parameter is 3600 seconden. Als er geen waarde wordt doorgegeven, wordt de standaardwaarde toegepast. Moet een geheel getal zijn.
Minimum value is 1, Maximum value is 3600.
behavior_settings
object
Toon 2 behavior_settings attributenVerberg behavior_settings attributen
frame_metrics
object
Toon 8 frame_metrics attributenVerberg frame_metrics attributen
navigating_away
object
Afhankelijk van het gewicht van deze framemetriek zal Proctorio markeren wanneer de kandidaat de examenpagina verlaat.
Minimum value is 0, Maximum value is 5.
keystrokes
object
Afhankelijk van het gewicht van deze framemetriek zal Proctorio markeren wanneer de kandidaat typt in het examenvenster.
Minimum value is 0, Maximum value is 5.
copy_paste
object
Afhankelijk van het gewicht van deze framemetriek zal Proctorio markeren wanneer de kandidaat kopieert, knipt of plakt in het examenvenster.
Minimum value is 0, Maximum value is 5.
browser_resize
object
Afhankelijk van het gewicht van deze framemetriek zal Proctorio markeren wanneer de kandidaat de browsergrootte wijzigt tijdens het examen.
Minimum value is 0, Maximum value is 5.
audio_levels
object
Afhankelijk van het gewicht van deze framemetriek zal Proctorio markeren wanneer het omgevingsgeluid een niveau boven de achtergrondgeluiden van de examenomgeving bereikt.
Minimum value is 0, Maximum value is 5.
head_movement
object
Afhankelijk van het gewicht van deze framemetriek zal Proctorio markeren wanneer de kandidaat het hoofd wegdraait van het examenvenster.
Minimum value is 0, Maximum value is 5.
multiple_faces
object
Afhankelijk van het gewicht van deze framemetriek zal Proctorio markeren wanneer meerdere personen naar een examen kijken.
Minimum value is 0, Maximum value is 5.
leaving_room
object
Afhankelijk van het gewicht van deze framemetriek zal Proctorio kandidaten markeren die 20-30 seconden niet hebben geïnteracteerd met het toetsenbord en de muis en wier gezicht niet duidelijk zichtbaar is in de videofeed.
Minimum value is 0, Maximum value is 5.
exam_metrics
object
Toon 14 exam_metrics attributenVerberg exam_metrics attributen
navigating_away
boolean
Abnormale hoeveelheden wegnavigeren markeren de kandidaten die externe applicaties of materialen anders gebruiken dan de rest van de groep.
keystrokes
boolean
Abnormale hoeveelheid toetsaanslagen markeert de kandidaten die afhankelijk zijn van kopiëren en plakken of moeite hebben met open vragen.
copy_paste
boolean
Abnormale hoeveelheid kopieer-/plakactiviteit markeert de kandidaten die mogelijk materiaal uit het examen hebben gehaald of herhaaldelijk antwoorden in het examen hebben gebracht.
browser_resize
boolean
Abnormale hoeveelheid browsergrootteveranderingen markeert de kandidaten die mogelijk notities of ander materiaal achter het examenvenster verborgen hadden.
audio_levels
boolean
Abnormale veranderingen in geluidsniveaus markeren de kandidaten die significante veranderingen in geluidsactiviteit hadden gedurende het examen.
head_movement
boolean
Abnormale hoeveelheid hoofdbewegingen markeert de kandidaten die significant vaker of minder vaak van de camera wegkeken dan de rest van de groep.
multiple_faces
boolean
Abnormaal aantal gedetecteerde gezichten markeert de kandidaten die mogelijk hulp van iemand hebben ontvangen tijdens het examen.
mouse_movement
boolean
Abnormale hoeveelheid muisbewegingen markeert de kandidaten die minder met de examenpagina hebben geïnteracteerd dan de rest van de groep.
scrolling
boolean
Abnormale hoeveelheid scrollen markeert de kandidaten die minder met de examenpagina hebben geïnteracteerd dan de rest van de groep.
clicking
boolean
Abnormale hoeveelheid klikken markeert de kandidaten die minder met de examenpagina hebben geïnteracteerd dan de rest van de groep.
exam_duration
boolean
Abnormale examenduur markeert de kandidaten die significant sneller of langzamer klaar waren dan de rest van de groep.
start_time
boolean
Starttijden markeren de kandidaten wier LMS-starttijd niet overeenkomt met de Proctorio-starttijd.
end_time
boolean
Eindtijden markeren de kandidaten wier LMS-eindtijd niet overeenkomt met de Proctorio-eindtijd.
exam_collusion
boolean
Examensamenzwering markeert de kandidaten die het examen op hetzelfde moment op hetzelfde netwerk hebben afgelegd.
proctor_settings
object
Toon 4 proctor_settings attributenVerberg proctor_settings attributen
break_allowed
boolean
Met deze optie kan een proctor een kandidaat een pauze geven door "Give break" te selecteren in het optiemenu. Deze optie is alleen beschikbaar wanneer een kandidaat is geclaimd door een proctor.
desk_scan_allowed
boolean
Met deze optie kan een proctor een bureauscan initiëren door "Initiate Desk Scan" te selecteren in het optiemenu. Een bureauscan initiëren zal de kandidaat vragen om het bureau of de omgeving te scannen tijdens het examen. Deze optie is alleen beschikbaar wanneer een kandidaat is geclaimd door een proctor.
interrupt_allowed
boolean
Met deze optie kan een proctor de poging van een kandidaat onderbreken/hervatten. Deze optie is alleen beschikbaar wanneer een kandidaat is geclaimd door een proctor.
kickout_allowed
boolean
Met deze optie kan een proctor een kandidaat uit de poging verwijderen. Deze optie is alleen beschikbaar wanneer een kandidaat is geclaimd door een proctor.

Reacties

200application/json

Geeft succes aan en retourneert een proctor Launchpad-URL.

400application/json

Geeft een ongeldig verzoek aan.

401application/json

Geeft een niet-geautoriseerd antwoord aan.

2154 - Account niet actief.

2155 - Onjuiste regio.

2655 - Ongeldige api_key.

POST/v2/live/launchpad
curl --request POST \
  --url https://us1.proctorapi.com/v2/live/launchpad \
  --header 'Content-Type: application/json' \
  --header 'api_key: $API_KEY' \
  --data '{"user_id":"example-id-123","exam_roster":"https://example.com/exam"}'
import requests

url = "https://us1.proctorapi.com/v2/live/launchpad"

payload = {
    "user_id": "example-id-123",
    "exam_roster": "https://example.com/exam"
}
headers = {
    "api_key": "$API_KEY",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
const fetch = require('node-fetch');

const url = 'https://us1.proctorapi.com/v2/live/launchpad';
const options = {
  method: 'POST',
  headers: {api_key: '$API_KEY', 'Content-Type': 'application/json'},
  body: '{"user_id":"example-id-123","exam_roster":"https://example.com/exam"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://us1.proctorapi.com/v2/live/launchpad"),
    Headers =
    {
        { "api_key", "$API_KEY" },
    },
    Content = new StringContent("{\"user_id\":\"example-id-123\",\"exam_roster\":\"https://example.com/exam\"}")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}
Voorbeeldverzoeken
{
  "user_id": "example-id-123",
  "exam_roster": "https://example.com/exam"
}