Als Markdown anzeigen

ReviewerLaunch

POST/v2/reviewer/launch
Basis-URL
https://us1.proctorapi.com
Verfügbare Regionen10 Regionen
Erstellt eine Reviewer-URL.
application/json

Body

Die Reviewer-Anfrage zur Erstellung einer Reviewer-URL.

expire
integer(int32)
Anzahl der Sekunden, bevor die Reviewer-URL nicht mehr gültig ist. Der Standardwert für diesen Parameter beträgt 3600 Sekunden. Wenn kein Wert übergeben wird, wird der Standardwert angewendet. Muss ein ganzzahliger Wert sein.
Minimum value is 1, Maximum value is 3600.
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.
exam_settings
objectErforderlich
Zeige 30 exam_settings AttributeVerberge exam_settings Attribute
record_video
boolean
Erfordert, dass der Kandidat eine Webcam hat, und zeichnet das Video für die gesamte Dauer der Prüfung auf.
record_audio
boolean
Erfordert, dass der Kandidat ein Mikrofon hat, und zeichnet Audio für die gesamte Dauer der Prüfung auf.
record_screen
boolean
Erfasst und zeichnet den gesamten Desktop-Bildschirm für die gesamte Dauer der Prüfung auf.
record_web_traffic
boolean
Erfasst Screenshots und URLs aller während der Prüfung besuchten Websites.
record_desk
integer(int32)

0 - Einstellung ist deaktiviert.

1 - Erfordert, dass der Kandidat in regelmäßigen Abständen während der Prüfung einen Schreibtisch-Scan durchführt; der erste Scan erfolgt zu Beginn der Prüfung. Nachfolgende Scans werden in regelmäßigen Abständen ausgelöst, typischerweise zwischen 30 und 45 Minuten nach dem vorherigen. Erfordert, dass die folgenden Einstellungen auf true gesetzt sind: record_video, verify_video.

2 - Erfordert, dass der Kandidat zu Beginn der Prüfung einen Schreibtisch-Scan durchführt. Erfordert, dass die folgenden Einstellungen auf true gesetzt sind: record_video, verify_video.

Values are 0, 1, 2.
verify_video
boolean
Stellt sicher, dass die Webcam funktioniert und nicht virtualisiert oder defekt ist. Erfordert, dass die folgenden Einstellungen auf true gesetzt sind: record_video.
verify_audio
boolean
Stellt sicher, dass das Mikrofon funktioniert und nicht virtualisiert oder stummgeschaltet ist. Erfordert, dass die folgenden Einstellungen auf true gesetzt sind: record_audio.
verify_desktop
boolean
Stellt sicher, dass die Desktop-Aufzeichnung funktioniert und ordnungsgemäß aufgezeichnet wird. Erfordert, dass die folgenden Einstellungen auf true gesetzt sind: record_screen.
verify_id
integer(int32)

0 - Einstellung ist deaktiviert.

1 - Erfordert, dass der Kandidat vor Beginn der Prüfung einen Lichtbildausweis vorlegt, der automatisch gescannt wird.

2 - Erfordert, dass der Kandidat vor Beginn der Prüfung einen Lichtbildausweis vorlegt. Der Ausweis wird dann von einem Proctorio-Mitarbeiter überprüft und verifiziert, bevor der Kandidat zur Prüfung zugelassen wird. Erfordert, dass die folgenden Einstellungen auf true gesetzt sind: record_video, verify_video.

Values are 0, 1, 2.
verify_signature
boolean
Erfordert, dass der Kandidat vor Beginn der Prüfung eine Vereinbarung unterschreibt.
full_screen
integer(int32)

0 - Einstellung ist deaktiviert.

1 - Erzwingt die Prüfung im Vollbildmodus und verhindert den Zugriff auf andere Anwendungen und Websites. Das Verlassen der Prüfungsseite für mehr als 15 Sekunden (kumulativ) führt zum Ausschluss aus der Prüfung. Erfordert, dass die folgenden Einstellungen auf true gesetzt sind: close_tabs, one_screen. Erfordert, dass tabs den Wert 1 hat.

2 - Erzwingt die Prüfung im Vollbildmodus und verhindert den Zugriff auf andere Anwendungen und Websites. Das Verlassen der Prüfungsseite für mehr als 30 Sekunden (kumulativ) führt zum Ausschluss aus der Prüfung. Erfordert, dass die folgenden Einstellungen auf true gesetzt sind: close_tabs, one_screen. Erfordert, dass tabs den Wert 1 hat.

3 - Erzwingt die Prüfung im Vollbildmodus und verhindert den Zugriff auf andere Anwendungen und Websites. Das Verlassen der Prüfungsseite führt zum sofortigen Ausschluss aus der Prüfung. Erfordert, dass die folgenden Einstellungen auf true gesetzt sind: close_tabs, one_screen. Erfordert, dass tabs den Wert 1 hat.

Values are 0, 1, 2, 3.
disable_clipboard
boolean
Deaktiviert die Kopieren/Einfügen-Funktionalität.
tabs
integer(int32)

0 - Einstellung ist deaktiviert.

1 - Deaktiviert neue Tabs oder Fenster während der Prüfung.

2 - Deaktiviert neue Tabs oder Fenster während der Prüfung, mit Ausnahme von Links, die in die Prüfungsseite eingebettet sind.

Values are 0, 1, 2.
close_tabs
boolean
Erzwingt das Schließen aller anderen Tabs und Fenster vor Beginn der Prüfung.
one_screen
boolean
Erzwingt, dass der Kandidat alle Monitore bis auf einen deaktiviert, bevor er die Prüfung beginnt, und verhindert, dass während der Prüfung zusätzliche Monitore angeschlossen werden.
disable_printing
boolean
Deaktiviert das Drucken von Prüfungsinhalten, um die Verbreitung der Prüfung zu verhindern.
block_downloads
boolean
Verhindert, dass der Kandidat Dateien über den Browser herunterlädt.
clear_cache
boolean
Leert temporäre Systemdateien nach Einreichung der Prüfung.
disable_right_click
boolean
Deaktiviert die Rechtsklick-Funktionen.
calculator
integer(int32)

0 - Einstellung ist deaktiviert.

1 - Stellt dem Kandidaten einen Bildschirmrechner mit Grundfunktionen zur Verfügung.

2 - Stellt dem Kandidaten einen Bildschirmrechner mit wissenschaftlichen Funktionen zur Verfügung.

3 - Stellt dem Kandidaten einen Bildschirmrechner mit Grafikfunktionen zur Verfügung.

Values are 0, 1, 2, 3.
whiteboard
boolean
Stellt dem Kandidaten ein Notizfeld und Zeichenwerkzeuge auf dem Bildschirm zur Verfügung.
disable_extensions
boolean
Verhindert, dass der Kandidat während der Prüfung andere Browsererweiterungen verwendet, mit Ausnahme von freigegebenen.
live_proctor
boolean
Diese Einstellung ermöglicht es einem Proctor, den Kandidaten während der Prüfung zu überwachen und sofort einzugreifen. Außerdem wird die vollständige Aufzeichnung und der Bericht über das Proctorio Review Center verfügbar sein. Erfordert, dass die folgenden Einstellungen auf true gesetzt sind: record_video, verify_video.
mobile
boolean
Ermöglicht die Durchführung der Prüfung auf einem mobilen Gerät mit der MobileExam-Anwendung. Erfordert die Verwendung von pre_auth in der Launch-Anfrage. Nicht kompatibel mit der Einstellung verify_id: 2.
advanced_program_detection
boolean
Verhindert die Nutzung anderer Anwendungen während der Prüfung. Erfordert die Verwendung der Secure Companion-Anwendung.
advanced_hardware_detection
boolean
Protokolliert Hardwareänderungen während der Prüfung im Review Center. Erfordert die Verwendung der Secure Companion-Anwendung.
advanced_vm_detection
boolean
Verhindert die Verwendung einer virtuellen Maschine zur Durchführung der Prüfung. Erfordert die Verwendung der Secure Companion-Anwendung.
allowed_macos_apps
array[string]
Liste von maximal 10 erlaubten Anwendungen, die geöffnet bleiben dürfen, wenn advanced_program_detection verwendet wird. Anwendungen werden auf MacOS durch die bundle ID identifiziert.
allowed_windows_apps
array[object]
Liste von maximal 10 erlaubten Anwendungen, die geöffnet bleiben dürfen, wenn advanced_program_detection verwendet wird. Anwendungen werden auf Windows durch binary_name, product_name und company_name identifiziert.
Zeige 3 allowed_windows_apps AttributeVerberge allowed_windows_apps Attribute
binary_name
string
Der Binärname der Anwendung.
product_name
string
Der Produktname der Anwendung.
company_name
string
Der Firmenname der Anwendung.
strict_apps_validation
integer(int32)

Legt die Strenge der Validierung erlaubter Anwendungen fest, wenn advanced_program_detection, allowed_macos_apps und allowed_windows_apps verwendet werden.

0 - Einstellung ist deaktiviert.

1 - Standardvalidierung.

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

Der Parameter "domain" ist optional. Durch die Verwendung von "domain" werden die Prüfungsseiten sowie das Reviewer Center mit Ihrer gewünschten Domain geladen.

Die URL wird nicht mehr auf die Seite https://getproctorio.com verweisen. Stattdessen werden die Kandidaten/Reviewer zur neuen Route weitergeleitet, die Sie im Parameter angegeben haben, beispielsweise: https://yourdomain.com.

Dies ermöglicht die Nutzung zusätzlicher Cross-Origin-Sicherheitsmechanismen, die SameSite-Cookies oder den X-Frame-Options: SAMEORIGIN-Header verwenden. Es bietet auch die Möglichkeit, Datenverluste in Session- oder Local-Storage im Zusammenhang mit der Storage-Partitionierungsfunktion des Browsers zu verhindern.

Die Seite https://getproctorio.com hat folgende Funktionen: Prüfung, ob ein Kandidat/Reviewer den unterstützten Browser installiert hat. Prüfung, ob ein Kandidat/Reviewer die Proctorio-Erweiterung installiert hat. Um diese Funktionen beizubehalten, ist ein Link zu https://getproctorio.com mit einer Beschreibung des Zwecks von getproctorio.com auf der Seite der Institution erforderlich.

branding
object
Zeige 3 branding AttributeVerberge branding Attribute
primary_color
string
Der Hex-Farbcode legt die Primärfarbe für einige Benutzeroberflächenelemente fest. Der Wert muss ein sechsstelliger Code ohne das #-Zeichen sein. Ermöglicht es einer Lernplattform, ihr eigenes Farbschema mit den Proctorio-Farben abzustimmen und ihre Marke im Header hervorzuheben. Muss ein Zeichenkettenwert sein.
Format should match: ^[a-zA-Z0-9]*$.
secondary_color
string
Der Hex-Farbcode legt die Sekundärfarbe für einige Benutzeroberflächenelemente fest. Der Wert muss ein sechsstelliger Code ohne das #-Zeichen sein. Ermöglicht es einer Lernplattform, ihr eigenes Farbschema mit den Proctorio-Farben abzustimmen und ihre Marke hervorzuheben. Muss ein Zeichenkettenwert sein.
Format should match: ^[a-zA-Z0-9]*$.
logo_url
string
URL des benutzerdefinierten Logo-Endpunkts. HTTP-Methode: GET. Die Antwort sollte ein Bild sein. CORS-sicher. Die Höhe des Logos beträgt 32px, die Breite ist flexibel.
user_id
stringErforderlich
Muss einen alphanumerischen Wert enthalten (Bindestriche sind ebenfalls zulässig), der für diesen spezifischen Benutzer eindeutig ist.
Format should match: ^[a-zA-Z0-9-]*$.
exam_tag
string
Dies ist das Prüfungs-ID-Tag und wird am Ende der URL hinzugefügt. Der exam_tag darf keine Leerzeichen und keine Nicht-ASCII-Zeichen enthalten. Bei Verwendung bezieht Proctorio es in die Antwort ein. Wird er nicht verwendet, wird eine URL ohne Hash generiert, die von der Lernplattform vor der Verwendung hinzugefügt werden muss. Proctorio empfiehlt die Verwendung der roster_url, wenn kein exam_tag angegeben wird.
Format should match: ^(?!goodbye$|support$|update$|setup$|invalid$).*.
section_id
string

Repräsentiert eine Kurs-ID oder einen Abschnitts-ID-Wert. Dieser Parameter ist optional. Er ermöglicht eine detailliertere Sortierung der Prüfungen.

Das bedeutet, dass Prüfungen mit dem gleichen "exam_tag", aber unterschiedlicher "section_id" als verschiedene Prüfungen behandelt werden.

Der Parameter "section_id" ist vom Parameter "roster_url" abhängig und kann nicht ohne diesen verwendet werden.

roster_url
string

URL des Roster-Endpunkts. HTTP-Methode: GET. Die Antwort sollte ein JSON-stringifiziertes Array sein. Beispiel: '[["id1","name1"],["id2","name2"]]'

Der Wert "id" sollte dem Parameter "userId" entsprechen, für den Kandidaten eindeutig und innerhalb des Rosters nicht wiederholbar sein.

Der Roster-Endpunkt wird von Proctorio validiert. Das bedeutet, dass bei Angabe eines ungültigen Endpunkts oder wenn "userId" keinem "id"-Wert im Array entspricht, die Versuche im Review Center als "Nicht zugeordnet" markiert werden.

Die roster_url wird nur vom Endbenutzer abgerufen, der auf das Review Center oder die Prüfungsvereinbarungsseite zugreift, clientseitig, nicht direkt von Proctorio. Das bedeutet, dass sie mit der Sitzung für den jeweiligen Benutzer gesichert werden kann. Dies ist beabsichtigt, und daher müssen personenbezogene Daten zu keinem Zeitpunkt an Proctorio übermittelt werden, weder bei einer Candidate-Launch-Anfrage noch bei einer Reviewer-Launch-Anfrage.

Antworten

200application/json

Zeigt Erfolg an und gibt eine Reviewer-URL 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/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);
}
Anfrage-Beispiele
{
  "exam_settings": {
    "record_video": true,
    "record_audio": false,
    "record_screen": false,
    "verify_video": false
  },
  "user_id": "example-id-123"
}