Afficher en Markdown

WebhooksSubscribe

POST/v2/whks/subscribe/{type}
URL de base
https://us1.proctorapi.com
Régions disponibles10 régions
La requête d'abonnement formalise l'initiation d'un abonnement aux notifications webhook de Proctorio.

Paramètres de chemin

type
stringObligatoire
1 - Type de webhook de calcul de suspicion
application/json

Body

La requête d'abonnement.

behavior_settings
object
Afficher 2 attributs behavior_settingsMasquer les attributs behavior_settings
frame_metrics
object
Afficher 8 attributs frame_metricsMasquer les attributs frame_metrics
navigating_away
object
En fonction du poids de cette métrique d'image, Proctorio signalera lorsque le candidat quitte la page d'examen.
Minimum value is 0, Maximum value is 5.
keystrokes
object
En fonction du poids de cette métrique d'image, Proctorio signalera chaque fois que le candidat tape au clavier dans la fenêtre d'examen.
Minimum value is 0, Maximum value is 5.
copy_paste
object
En fonction du poids de cette métrique d'image, Proctorio signalera lorsque le candidat copie, coupe ou colle dans la fenêtre d'examen.
Minimum value is 0, Maximum value is 5.
browser_resize
object
En fonction du poids de cette métrique d'image, Proctorio signalera lorsque le candidat modifie la taille du navigateur pendant un examen.
Minimum value is 0, Maximum value is 5.
audio_levels
object
En fonction du poids de cette métrique d'image, Proctorio signalera lorsque le bruit ambiant atteint un niveau supérieur au bruit de fond de l'environnement d'examen.
Minimum value is 0, Maximum value is 5.
head_movement
object
En fonction du poids de cette métrique d'image, Proctorio signalera lorsque le candidat détourne la tête de la fenêtre d'examen.
Minimum value is 0, Maximum value is 5.
multiple_faces
object
En fonction du poids de cette métrique d'image, Proctorio signalera lorsque plusieurs personnes regardent un examen.
Minimum value is 0, Maximum value is 5.
leaving_room
object
En fonction du poids de cette métrique d'image, Proctorio signalera les candidats qui n'ont pas interagi avec le clavier et la souris pendant 20 à 30 secondes et dont le visage n'est pas clairement visible dans le flux vidéo.
Minimum value is 0, Maximum value is 5.
exam_metrics
object
Afficher 14 attributs exam_metricsMasquer les attributs exam_metrics
navigating_away
boolean
Un nombre anormal de sorties de page mettra en évidence les candidats qui utilisent des applications ou des supports externes différemment du reste du groupe.
keystrokes
boolean
Un nombre anormal de frappes au clavier mettra en évidence les candidats qui s'appuient sur le copier-coller ou qui ont des difficultés avec les questions à réponse libre.
copy_paste
boolean
Un nombre anormal d'activités de copier/coller mettra en évidence les candidats qui ont pu extraire du contenu de l'examen ou apporter des réponses dans l'examen de manière répétée.
browser_resize
boolean
Un nombre anormal de redimensionnements du navigateur mettra en évidence les candidats qui ont pu avoir des notes ou d'autres supports cachés derrière la fenêtre d'examen.
audio_levels
boolean
Des changements anormaux des niveaux sonores mettront en évidence les candidats qui ont eu des variations significatives d'activité audio tout au long de l'examen.
head_movement
boolean
Un nombre anormal de mouvements de la tête mettra en évidence les candidats qui ont détourné le regard de la caméra de manière significativement plus fréquente ou moins fréquente que le reste du groupe.
multiple_faces
boolean
Un nombre anormal de visages détectés mettra en évidence les candidats qui ont pu recevoir de l'aide de quelqu'un pendant l'examen.
mouse_movement
boolean
Un nombre anormal de mouvements de la souris mettra en évidence les candidats qui ont interagi avec la page d'examen moins que le reste du groupe.
scrolling
boolean
Un nombre anormal de défilements mettra en évidence les candidats qui ont interagi avec la page d'examen moins que le reste du groupe.
clicking
boolean
Un nombre anormal de clics mettra en évidence les candidats qui ont interagi avec la page d'examen moins que le reste du groupe.
exam_duration
boolean
Une durée d'examen anormale mettra en évidence les candidats qui ont terminé de manière significativement plus rapide ou significativement plus lente que le reste du groupe.
start_time
boolean
Les heures de début mettront en évidence les candidats dont l'heure de début LMS ne correspond pas à l'heure de début Proctorio.
end_time
boolean
Les heures de fin mettront en évidence les candidats dont l'heure de fin LMS ne correspond pas à l'heure de fin Proctorio.
exam_collusion
boolean
La collusion d'examen mettra en évidence les candidats qui ont passé l'examen en même temps sur le même réseau.
version
string
Version du webhook de calcul de suspicion auquel s'abonner. Les versions actuellement prises en charge sont '2' et '3'.
client
objectObligatoire
Afficher 2 attributs clientMasquer les attributs client
url
stringObligatoire
Représente l'URL du point de terminaison client.
key
string
Le paramètre Key représente la valeur de la clé API du client. Ce paramètre est optionnel.

Réponses

200application/json

Indique le succès et renvoie la réponse d'abonnement.

400application/json

Indique une requête incorrecte.

401application/json

Indique une réponse non autorisée.

2154 - Compte non actif.

2155 - Région incorrecte.

2655 - api_key invalide.

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);
}
Exemples de requête
{
  "client": {
    "url": "https://example.com",
    "key": "string"
  }
}