Als Markdown anzeigen

WebhooksSubscribe

POST/v2/whks/subscribe/{type}
Basis-URL
https://us1.proctorapi.com
Verfügbare Regionen10 Regionen
Die Abonnement-Anfrage formalisiert die Einrichtung eines Abonnements für Proctorio-Webhook-Benachrichtigungen.

Pfadparameter

type
stringErforderlich
1 - Webhook-Typ für Verdachtsberechnung
application/json

Body

Die Abonnement-Anfrage.

behavior_settings
object
Zeige 2 behavior_settings AttributeVerberge behavior_settings Attribute
frame_metrics
object
Zeige 8 frame_metrics AttributeVerberge frame_metrics Attribute
navigating_away
object
Abhängig von der Gewichtung dieser Frame-Metrik markiert Proctorio, wenn der Kandidat die Prüfungsseite verlässt.
Minimum value is 0, Maximum value is 5.
keystrokes
object
Abhängig von der Gewichtung dieser Frame-Metrik markiert Proctorio jedes Mal, wenn der Kandidat innerhalb des Prüfungsfensters tippt.
Minimum value is 0, Maximum value is 5.
copy_paste
object
Abhängig von der Gewichtung dieser Frame-Metrik markiert Proctorio, wenn der Kandidat innerhalb des Prüfungsfensters kopiert, ausschneidet oder einfügt.
Minimum value is 0, Maximum value is 5.
browser_resize
object
Abhängig von der Gewichtung dieser Frame-Metrik markiert Proctorio, wenn der Kandidat die Browsergröße während der Prüfung ändert.
Minimum value is 0, Maximum value is 5.
audio_levels
object
Abhängig von der Gewichtung dieser Frame-Metrik markiert Proctorio, wenn die Umgebungsgeräusche einen Pegel über dem Grundrauschen der Prüfungsumgebung erreichen.
Minimum value is 0, Maximum value is 5.
head_movement
object
Abhängig von der Gewichtung dieser Frame-Metrik markiert Proctorio, wenn der Kandidat seinen Kopf vom Prüfungsfenster wegbewegt.
Minimum value is 0, Maximum value is 5.
multiple_faces
object
Abhängig von der Gewichtung dieser Frame-Metrik markiert Proctorio, wenn mehrere Personen auf eine Prüfung schauen.
Minimum value is 0, Maximum value is 5.
leaving_room
object
Abhängig von der Gewichtung dieser Frame-Metrik markiert Proctorio Kandidaten, die 20-30 Sekunden lang nicht mit Tastatur und Maus interagiert haben und deren Gesicht im Videofeed nicht deutlich sichtbar ist.
Minimum value is 0, Maximum value is 5.
exam_metrics
object
Zeige 14 exam_metrics AttributeVerberge exam_metrics Attribute
navigating_away
boolean
Ungewöhnlich häufiges Verlassen hebt Kandidaten hervor, die externe Anwendungen oder Materialien anders nutzen als der Rest der Gruppe.
keystrokes
boolean
Eine ungewöhnliche Anzahl von Tastatureingaben hebt Kandidaten hervor, die auf Kopieren und Einfügen angewiesen sind oder Schwierigkeiten mit Freitextfragen haben.
copy_paste
boolean
Ungewöhnlich viel Kopieren/Einfügen-Aktivität hebt Kandidaten hervor, die möglicherweise Material aus der Prüfung entnommen oder wiederholt Antworten in die Prüfung eingebracht haben.
browser_resize
boolean
Ungewöhnlich häufige Größenänderung des Browsers hebt Kandidaten hervor, die möglicherweise Notizen oder anderes Material hinter dem Prüfungsfenster versteckt hatten.
audio_levels
boolean
Ungewöhnliche Änderungen der Audiopegel heben Kandidaten hervor, die signifikante Änderungen der Audioaktivität während der Prüfung aufwiesen.
head_movement
boolean
Ungewöhnlich viel Kopfbewegung hebt Kandidaten hervor, die deutlich häufiger oder seltener als der Rest der Gruppe von der Kamera weggeschaut haben.
multiple_faces
boolean
Eine ungewöhnliche Anzahl erkannter Gesichter hebt Kandidaten hervor, die möglicherweise während der Prüfung Hilfe von jemand anderem erhalten haben.
mouse_movement
boolean
Ungewöhnlich viel Mausbewegung hebt Kandidaten hervor, die weniger mit der Prüfungsseite interagiert haben als der Rest der Gruppe.
scrolling
boolean
Ungewöhnlich viel Scrollen hebt Kandidaten hervor, die weniger mit der Prüfungsseite interagiert haben als der Rest der Gruppe.
clicking
boolean
Ungewöhnlich viel Klicken hebt Kandidaten hervor, die weniger mit der Prüfungsseite interagiert haben als der Rest der Gruppe.
exam_duration
boolean
Ungewöhnliche Prüfungsdauer hebt Kandidaten hervor, die deutlich schneller oder langsamer als der Rest der Gruppe fertig geworden sind.
start_time
boolean
Startzeiten heben Kandidaten hervor, deren LMS-Startzeit nicht mit der Proctorio-Startzeit übereinstimmt.
end_time
boolean
Endzeiten heben Kandidaten hervor, deren LMS-Endzeit nicht mit der Proctorio-Endzeit übereinstimmt.
exam_collusion
boolean
Prüfungskollusion hebt Kandidaten hervor, die die Prüfung zur gleichen Zeit im gleichen Netzwerk abgelegt haben.
version
string
Version des Verdachtsberechnungs-Webhooks, den Sie abonnieren möchten. Derzeit unterstützte Versionen sind '2' und '3'.
client
objectErforderlich
Zeige 2 client AttributeVerberge client Attribute
url
stringErforderlich
Repräsentiert die Client-Endpunkt-URL.
key
string
Der Key-Parameter repräsentiert den API-Schlüsselwert des Clients. Dieser Parameter ist optional.

Antworten

200application/json

Zeigt Erfolg an und gibt die Abonnement-Antwort zurück.

400application/json

Zeigt eine fehlerhafte Anfrage an.

401application/json

Zeigt eine nicht autorisierte Antwort an.

2154 - Konto nicht aktiv.

2155 - Falsche Region.

2655 - Ungültiger 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);
}
Anfrage-Beispiele
{
  "client": {
    "url": "https://example.com",
    "key": "string"
  }
}