LiveLaunch
https://us1.proctorapi.comBody
Die Proctor-Anfrage zur Erstellung einer Proctor-Live-URL.
1, Maximum value is 3600.^[a-zA-Z0-9-]*$.^(?!goodbye$|support$|update$|setup$|invalid$).*.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.
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.
Antworten200application/jsonZeigt Erfolg an und gibt eine Proctor-URL zurück.
400application/jsonZeigt eine fehlerhafte Anfrage an.
401application/jsonZeigt eine nicht autorisierte Antwort an.
2154 - Konto nicht aktiv.
2155 - Falsche Region.
2655 - Ungültiger api_key.
Zeigt Erfolg an und gibt eine Proctor-URL zurück.
Zeigt eine fehlerhafte Anfrage an.
Zeigt eine nicht autorisierte Antwort an.
2154 - Konto nicht aktiv.
2155 - Falsche Region.
2655 - Ungültiger api_key.
curl --request POST \
--url https://us1.proctorapi.com/v2/live/launch \
--header 'Content-Type: application/json' \
--header 'api_key: $API_KEY' \
--data '{"user_id":"example-id-123"}'import requests
url = "https://us1.proctorapi.com/v2/live/launch"
payload = { "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/live/launch';
const options = {
method: 'POST',
headers: {api_key: '$API_KEY', 'Content-Type': 'application/json'},
body: '{"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/live/launch"),
Headers =
{
{ "api_key", "$API_KEY" },
},
Content = new StringContent("{\"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);
}{
"user_id": "example-id-123"
}