LiveLaunch
https://us1.proctorapi.comBody
Het proctor-verzoek om een proctor live-URL aan te maken.
1, Maximum value is 3600.^[a-zA-Z0-9-]*$.^(?!goodbye$|support$|update$|setup$|invalid$).*.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-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.
Reacties200application/jsonGeeft succes aan en retourneert een proctor-URL.
400application/jsonGeeft een ongeldig verzoek aan.
401application/jsonGeeft een niet-geautoriseerd antwoord aan.
2154 - Account niet actief.
2155 - Onjuiste regio.
2655 - Ongeldige api_key.
Geeft succes aan en retourneert een proctor-URL.
Geeft een ongeldig verzoek aan.
Geeft een niet-geautoriseerd antwoord aan.
2154 - Account niet actief.
2155 - Onjuiste regio.
2655 - Ongeldige 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"
}