Weergeven als Markdown

ReviewerLaunch

POST/v2/reviewer/launch
Basis-URL
https://us1.proctorapi.com
Beschikbare regio's10 regio's
Maakt een reviewer-URL aan.
application/json

Body

Het reviewer-verzoek om een reviewer-URL aan te maken.

expire
integer(int32)
Aantal seconden voordat de reviewer-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.
exam_settings
objectVereist
Toon 30 exam_settings attributenVerberg exam_settings attributen
record_video
boolean
Vereist dat de kandidaat een webcam heeft en neemt de video op gedurende de gehele duur van het examen.
record_audio
boolean
Vereist dat de kandidaat een microfoon heeft en neemt audio op gedurende de gehele duur van het examen.
record_screen
boolean
Legt het volledige bureaublad vast en neemt het op gedurende de gehele duur van het examen.
record_web_traffic
boolean
Legt schermafbeeldingen en URL's vast van alle websites die tijdens het examen worden bezocht.
record_desk
integer(int32)

0 - Instelling is uitgeschakeld.

1 - Vereist dat de kandidaat op periodieke intervallen tijdens het examen een bureauscan uitvoert; de eerste scan vindt plaats bij de start van het examen. Volgende scans worden op periodieke intervallen geactiveerd, doorgaans tussen 30 en 45 minuten na de vorige. Vereist dat de volgende instellingen zijn ingesteld op true: record_video, verify_video.

2 - Vereist dat de kandidaat een bureauscan uitvoert bij de start van het examen. Vereist dat de volgende instellingen zijn ingesteld op true: record_video, verify_video.

Values are 0, 1, 2.
verify_video
boolean
Controleert of de webcam werkt en niet gevirtualiseerd of defect is. Vereist dat de volgende instellingen zijn ingesteld op true: record_video.
verify_audio
boolean
Controleert of de microfoon werkt en niet gevirtualiseerd of gedempt is. Vereist dat de volgende instellingen zijn ingesteld op true: record_audio.
verify_desktop
boolean
Controleert of de bureaubladopname werkt en correct wordt opgenomen. Vereist dat de volgende instellingen zijn ingesteld op true: record_screen.
verify_id
integer(int32)

0 - Instelling is uitgeschakeld.

1 - Vereist dat de kandidaat een identiteitsbewijs met foto toont voordat het examen begint, dat automatisch wordt gescand.

2 - Vereist dat de kandidaat een identiteitsbewijs met foto toont voordat het examen begint. Het identiteitsbewijs wordt vervolgens beoordeeld en geverifieerd door een Proctorio-medewerker voordat de kandidaat toegang krijgt tot het examen. Vereist dat de volgende instellingen zijn ingesteld op true: record_video, verify_video.

Values are 0, 1, 2.
verify_signature
boolean
Vereist dat de kandidaat een overeenkomst ondertekent voordat het examen begint.
full_screen
integer(int32)

0 - Instelling is uitgeschakeld.

1 - Dwingt het examen in volledig scherm af, waardoor toegang tot andere applicaties en websites wordt voorkomen. Het verlaten van de examenpagina voor meer dan 15 seconden (cumulatief) resulteert in verwijdering uit het examen. Vereist dat de volgende instellingen zijn ingesteld op true: close_tabs, one_screen. Vereist dat tabs de waarde 1 heeft.

2 - Dwingt het examen in volledig scherm af, waardoor toegang tot andere applicaties en websites wordt voorkomen. Het verlaten van de examenpagina voor meer dan 30 seconden (cumulatief) resulteert in verwijdering uit het examen. Vereist dat de volgende instellingen zijn ingesteld op true: close_tabs, one_screen. Vereist dat tabs de waarde 1 heeft.

3 - Dwingt het examen in volledig scherm af, waardoor toegang tot andere applicaties en websites wordt voorkomen. Het verlaten van de examenpagina resulteert in onmiddellijke verwijdering uit het examen. Vereist dat de volgende instellingen zijn ingesteld op true: close_tabs, one_screen. Vereist dat tabs de waarde 1 heeft.

Values are 0, 1, 2, 3.
disable_clipboard
boolean
Schakelt de kopieer-/plakfunctionaliteit uit.
tabs
integer(int32)

0 - Instelling is uitgeschakeld.

1 - Schakelt nieuwe tabbladen of vensters uit tijdens het examen.

2 - Schakelt nieuwe tabbladen of vensters uit tijdens het examen, behalve links die in de examenpagina zijn ingebed.

Values are 0, 1, 2.
close_tabs
boolean
Dwingt af dat alle andere tabbladen en vensters worden gesloten voordat het examen begint.
one_screen
boolean
Dwingt de kandidaat om alle monitoren behalve één uit te schakelen voordat het examen begint en voorkomt dat er tijdens het examen extra monitoren worden aangesloten.
disable_printing
boolean
Schakelt het afdrukken van exameninhoud uit om verspreiding van het examen te voorkomen.
block_downloads
boolean
Voorkomt dat de kandidaat bestanden downloadt via de browser.
clear_cache
boolean
Verwijdert tijdelijke systeembestanden nadat het examen is ingeleverd.
disable_right_click
boolean
Schakelt rechtermuisknopfunctionaliteiten uit.
calculator
integer(int32)

0 - Instelling is uitgeschakeld.

1 - Biedt de kandidaat een rekenmachine op het scherm met basisfuncties.

2 - Biedt de kandidaat een rekenmachine op het scherm met wetenschappelijke functies.

3 - Biedt de kandidaat een rekenmachine op het scherm met grafische functies.

Values are 0, 1, 2, 3.
whiteboard
boolean
Biedt de kandidaat een kladblok en tekengereedschap op het scherm.
disable_extensions
boolean
Voorkomt dat de kandidaat andere browserextensies gebruikt tijdens het examen, behalve extensies op de toelatingslijst.
live_proctor
boolean
Deze instelling stelt een proctor in staat om de kandidaat tijdens het examen te monitoren en direct in te grijpen. Daarnaast zijn de volledige opname en het rapport beschikbaar via het Proctorio Review Center. Vereist dat de volgende instellingen zijn ingesteld op true: record_video, verify_video.
mobile
boolean
Maakt het mogelijk om het examen af te leggen op een mobiel apparaat met de MobileExam-applicatie. Vereist het gebruik van pre_auth in het startverzoek. Niet compatibel met de instelling verify_id: 2.
advanced_program_detection
boolean
Voorkomt het gebruik van andere applicaties tijdens het examen. Vereist het gebruik van de Secure Companion-applicatie.
advanced_hardware_detection
boolean
Registreert hardwarewijzigingen tijdens het examen in het Review Center. Vereist het gebruik van de Secure Companion-applicatie.
advanced_vm_detection
boolean
Voorkomt het gebruik van een virtuele machine om het examen af te leggen. Vereist het gebruik van de Secure Companion-applicatie.
allowed_macos_apps
array[string]
Lijst van maximaal 10 toegestane applicaties die open mogen blijven wanneer advanced_program_detection wordt gebruikt. Applicaties worden geïdentificeerd op basis van bundle ID op MacOS.
allowed_windows_apps
array[object]
Lijst van maximaal 10 toegestane applicaties die open mogen blijven wanneer advanced_program_detection wordt gebruikt. Applicaties worden geïdentificeerd op basis van binary_name, product_name en company_name op Windows.
Toon 3 allowed_windows_apps attributenVerberg allowed_windows_apps attributen
binary_name
string
De binaire naam van de applicatie.
product_name
string
De productnaam van de applicatie.
company_name
string
De bedrijfsnaam van de applicatie.
strict_apps_validation
integer(int32)

Stelt het striktheidsniveau in voor het valideren van toegestane applicaties wanneer advanced_program_detection, allowed_macos_apps en allowed_windows_apps worden gebruikt.

0 - Instelling is uitgeschakeld.

1 - Standaardvalidatie.

Values are 0, 1.
record_desk_option
integer(int32)
Values are 0, 1, 2.
domain
string

De parameter "domain" is optioneel. Door "domain" te gebruiken, worden de examenpagina's en het Reviewer Center geladen met uw gewenste domein.

De URL zal niet langer verwijzen naar de pagina https://getproctorio.com. In plaats daarvan worden de kandidaten/reviewers doorgestuurd naar de nieuwe route die u in de parameter hebt opgegeven, bijvoorbeeld: https://yourdomain.com.

Dit maakt het gebruik van aanvullende cross-origin beveiligingsmechanismen mogelijk, die SameSite-cookies of de X-Frame-Options: SAMEORIGIN-header gebruiken. Het biedt ook de mogelijkheid om gegevensverlies in sessie- of lokale opslag te voorkomen gerelateerd aan opslagpartitioneringsfunctionaliteit van de browser.

De pagina https://getproctorio.com heeft de volgende functionaliteiten: controleren of een kandidaat/reviewer de ondersteunde browser heeft geïnstalleerd. Controleren of een kandidaat/reviewer de Proctorio-extensie heeft geïnstalleerd. Om deze functionaliteiten te behouden is een link naar https://getproctorio.com met inhoud die het doel van getproctorio.com beschrijft noodzakelijk op de pagina van de instelling.

branding
object
Toon 3 branding attributenVerberg branding attributen
primary_color
string
De hex-kleurcode specificeert de primaire kleur voor bepaalde gebruikersinterfacebedieningen. De waarde moet een zescijferige code zijn, zonder het #-teken. Maakt het mogelijk voor een leerplatform om het eigen kleurenschema af te stemmen op de kleuren van Proctorio en het merk te benadrukken in de header. Moet een tekenreekswaarde zijn.
Format should match: ^[a-zA-Z0-9]*$.
secondary_color
string
De hex-kleurcode specificeert de secundaire kleur voor bepaalde gebruikersinterfacebedieningen. De waarde moet een zescijferige code zijn, zonder het #-teken. Maakt het mogelijk voor een leerplatform om het eigen kleurenschema af te stemmen op de kleuren van Proctorio en het merk te benadrukken. Moet een tekenreekswaarde zijn.
Format should match: ^[a-zA-Z0-9]*$.
logo_url
string
Endpoint-URL voor een aangepast logo. HTTP-methode: GET. Het antwoord moet een afbeelding zijn. CORS-veilig. De hoogte van het logo is 32px, de breedte is flexibel.
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_tag
string
Dit is de examen-ID-tag en wordt toegevoegd aan het einde van de URL. De exam_tag mag geen spaties bevatten en mag geen niet-ASCII-tekens bevatten. Indien gebruikt, verwerkt Proctorio deze in het antwoord. Indien niet gebruikt, wordt een URL gegenereerd zonder de hash en moet deze door het leerplatform worden toegevoegd vóór gebruik. Proctorio raadt aan om de roster_url te gebruiken wanneer de exam_tag niet wordt opgegeven.
Format should match: ^(?!goodbye$|support$|update$|setup$|invalid$).*.
section_id
string

Vertegenwoordigt een cursus-ID of een sectie-ID-waarde. Deze parameter is optioneel. Het biedt een gedetailleerdere sortering van de examens.

Dat betekent dat examens met dezelfde "exam_tag" maar een andere "section_id" als verschillende examens worden behandeld.

De parameter "section_id" is afhankelijk van de parameter "roster_url" en kan niet zonder deze worden gebruikt.

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.

Reacties

200application/json

Geeft succes aan en retourneert een reviewer-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/reviewer/launch
curl --request POST \
  --url https://us1.proctorapi.com/v2/reviewer/launch \
  --header 'Content-Type: application/json' \
  --header 'api_key: $API_KEY' \
  --data '{"exam_settings":{"record_video":true,"record_audio":false,"record_screen":false,"verify_video":false},"user_id":"example-id-123"}'
import requests

url = "https://us1.proctorapi.com/v2/reviewer/launch"

payload = {
    "exam_settings": {
        "record_video": True,
        "record_audio": False,
        "record_screen": False,
        "verify_video": False
    },
    "user_id": "example-id-123"
}
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/reviewer/launch';
const options = {
  method: 'POST',
  headers: {api_key: '$API_KEY', 'Content-Type': 'application/json'},
  body: '{"exam_settings":{"record_video":true,"record_audio":false,"record_screen":false,"verify_video":false},"user_id":"example-id-123"}'
};

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/reviewer/launch"),
    Headers =
    {
        { "api_key", "$API_KEY" },
    },
    Content = new StringContent("{\"exam_settings\":{\"record_video\":true,\"record_audio\":false,\"record_screen\":false,\"verify_video\":false},\"user_id\":\"example-id-123\"}")
    {
        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
{
  "exam_settings": {
    "record_video": true,
    "record_audio": false,
    "record_screen": false,
    "verify_video": false
  },
  "user_id": "example-id-123"
}