Ver como Markdown

WebhooksSubscribe

POST/v2/whks/subscribe/{type}
URL base
https://us1.proctorapi.com
Regiones disponibles10 regiones
La solicitud de suscripción formaliza el inicio de una suscripción a las notificaciones de webhooks de Proctorio.

Parámetros de ruta

type
stringObligatorio
1 - Tipo de webhook de cálculo de sospecha
application/json

Body

La solicitud de suscripción.

behavior_settings
object
Mostrar 2 atributos de behavior_settingsOcultar atributos de behavior_settings
frame_metrics
object
Mostrar 8 atributos de frame_metricsOcultar atributos de frame_metrics
navigating_away
object
Dependiendo del peso de esta métrica de fotograma, Proctorio marcará cuando el candidato abandone la página del examen.
Minimum value is 0, Maximum value is 5.
keystrokes
object
Dependiendo del peso de esta métrica de fotograma, Proctorio marcará cada vez que el candidato escriba dentro de la ventana del examen.
Minimum value is 0, Maximum value is 5.
copy_paste
object
Dependiendo del peso de esta métrica de fotograma, Proctorio marcará cuando el candidato copie, corte o pegue dentro de la ventana del examen.
Minimum value is 0, Maximum value is 5.
browser_resize
object
Dependiendo del peso de esta métrica de fotograma, Proctorio marcará cuando el candidato cambie el tamaño del navegador mientras realiza un examen.
Minimum value is 0, Maximum value is 5.
audio_levels
object
Dependiendo del peso de esta métrica de fotograma, Proctorio marcará cuando el ruido ambiental alcance un nivel superior al ruido de fondo del entorno del examen.
Minimum value is 0, Maximum value is 5.
head_movement
object
Dependiendo del peso de esta métrica de fotograma, Proctorio marcará cuando el candidato mueva la cabeza lejos de la ventana del examen.
Minimum value is 0, Maximum value is 5.
multiple_faces
object
Dependiendo del peso de esta métrica de fotograma, Proctorio marcará cuando varias personas miren un examen.
Minimum value is 0, Maximum value is 5.
leaving_room
object
Dependiendo del peso de esta métrica de fotograma, Proctorio marcará a los candidatos que no hayan interactuado con el teclado y el ratón durante 20-30 segundos y cuyo rostro no sea claramente visible en la transmisión de vídeo.
Minimum value is 0, Maximum value is 5.
exam_metrics
object
Mostrar 14 atributos de exam_metricsOcultar atributos de exam_metrics
navigating_away
boolean
Una cantidad anormal de navegación fuera de la página destacará a los candidatos que estén utilizando aplicaciones o materiales externos de forma diferente al resto del grupo.
keystrokes
boolean
Una cantidad anormal de pulsaciones de teclas destacará a los candidatos que dependan de copiar y pegar o que tengan dificultades con las preguntas de respuesta libre.
copy_paste
boolean
Una cantidad anormal de actividad de copiar/pegar destacará a los candidatos que puedan haber extraído material del examen o introducido respuestas en el examen repetidamente.
browser_resize
boolean
Una cantidad anormal de cambios de tamaño del navegador destacará a los candidatos que puedan haber tenido notas u otro material oculto detrás de la ventana del examen.
audio_levels
boolean
Cambios anormales en los niveles de audio destacarán a los candidatos que hayan tenido cambios significativos en la actividad de audio durante el examen.
head_movement
boolean
Una cantidad anormal de movimiento de la cabeza destacará a los candidatos que hayan mirado lejos de la cámara significativamente más o significativamente menos que el resto del grupo.
multiple_faces
boolean
Un número anormal de rostros detectados destacará a los candidatos que puedan haber recibido ayuda de alguien durante el examen.
mouse_movement
boolean
Una cantidad anormal de movimiento del ratón destacará a los candidatos que hayan interactuado con la página del examen menos que el resto del grupo.
scrolling
boolean
Una cantidad anormal de desplazamiento destacará a los candidatos que hayan interactuado con la página del examen menos que el resto del grupo.
clicking
boolean
Una cantidad anormal de clics destacará a los candidatos que hayan interactuado con la página del examen menos que el resto del grupo.
exam_duration
boolean
Una duración anormal del examen destacará a los candidatos que hayan terminado significativamente más rápido o significativamente más lento que el resto del grupo.
start_time
boolean
Las horas de inicio destacarán a los candidatos cuya hora de inicio en el LMS no coincida con la hora de inicio de Proctorio.
end_time
boolean
Las horas de finalización destacarán a los candidatos cuya hora de finalización en el LMS no coincida con la hora de finalización de Proctorio.
exam_collusion
boolean
La colusión en el examen destacará a los candidatos que hayan realizado el examen al mismo tiempo en la misma red.
version
string
Versión del webhook de cálculo de sospecha al que suscribirse. Las versiones actualmente compatibles son '2' y '3'.
client
objectObligatorio
Mostrar 2 atributos de clientOcultar atributos de client
url
stringObligatorio
Representa la URL del endpoint del cliente.
key
string
El parámetro Key representa el valor de la clave API del cliente. Este parámetro es opcional.

Respuestas

200application/json

Indica éxito y devuelve la respuesta de suscripción.

400application/json

Indica una solicitud incorrecta.

401application/json

Indica una respuesta no autorizada.

2154 - Cuenta no activa.

2155 - Región incorrecta.

2655 - api_key inválido.

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