Weergeven als Markdown

WebhooksSubscribe

POST/v2/whks/subscribe/{type}
Basis-URL
https://us1.proctorapi.com
Beschikbare regio's10 regio's
Het abonnementsverzoek formaliseert het starten van een abonnement op Proctorio webhook-notificaties.

Padparameters

type
stringVereist
1 - Webhook-type voor verdachtberekening
application/json

Body

Het abonnementsverzoek.

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.
version
string
Versie van de verdachtberekening-webhook om op te abonneren. Momenteel ondersteunde versies zijn '2' en '3'.
client
objectVereist
Toon 2 client attributenVerberg client attributen
url
stringVereist
Vertegenwoordigt de client-endpoint-URL.
key
string
De Key-parameter vertegenwoordigt de API-sleutelwaarde van de client. Deze parameter is optioneel.

Reacties

200application/json

Geeft succes aan en retourneert het abonnementsantwoord.

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/whks/subscribe/{type}
curl --request POST \
  --url https://us1.proctorapi.com/v2/whks/subscribe/%7Btype%7D \
  --header 'Content-Type: application/json' \
  --header 'api_key: $API_KEY' \
  --data '{"client":{"url":"https://example.com","key":"string"}}'
import requests

url = "https://us1.proctorapi.com/v2/whks/subscribe/%7Btype%7D"

payload = { "client": {
        "url": "https://example.com",
        "key": "string"
    } }
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/whks/subscribe/%7Btype%7D';
const options = {
  method: 'POST',
  headers: {api_key: '$API_KEY', 'Content-Type': 'application/json'},
  body: '{"client":{"url":"https://example.com","key":"string"}}'
};

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/whks/subscribe/%7Btype%7D"),
    Headers =
    {
        { "api_key", "$API_KEY" },
    },
    Content = new StringContent("{\"client\":{\"url\":\"https://example.com\",\"key\":\"string\"}}")
    {
        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
{
  "client": {
    "url": "https://example.com",
    "key": "string"
  }
}