Ver como Markdown

ReviewerLaunch

POST/v2/reviewer/launch
URL base
https://us1.proctorapi.com
Regiones disponibles10 regiones
Crea una URL de revisor.
application/json

Body

La solicitud de revisor para crear una URL de revisor.

expire
integer(int32)
Número de segundos antes de que la URL del revisor deje de ser válida. El valor predeterminado para este parámetro es 3600 segundos. Si no se pasa un valor, se aplicará el valor predeterminado. Debe ser un valor entero.
Minimum value is 1, Maximum value is 3600.
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.
exam_settings
objectObligatorio
Mostrar 30 atributos de exam_settingsOcultar atributos de exam_settings
record_video
boolean
Requiere que el candidato tenga una cámara web y grabará el vídeo durante toda la duración del examen.
record_audio
boolean
Requiere que el candidato tenga un micrófono y grabará el audio durante toda la duración del examen.
record_screen
boolean
Capturará y grabará la pantalla completa del escritorio durante toda la duración del examen.
record_web_traffic
boolean
Capturará capturas de pantalla y URL de cualquier sitio web visitado durante el examen.
record_desk
integer(int32)

0 - La configuración está desactivada.

1 - Requiere que el candidato realice un escaneo del escritorio a intervalos periódicos durante el examen; el primer escaneo es al inicio del examen. Los escaneos posteriores se activan a intervalos periódicos, normalmente entre 30 y 45 minutos después del anterior. Requiere que las siguientes configuraciones estén establecidas en true: record_video, verify_video.

2 - Requiere que el candidato realice un escaneo del escritorio al inicio del examen. Requiere que las siguientes configuraciones estén establecidas en true: record_video, verify_video.

Values are 0, 1, 2.
verify_video
boolean
Verificará que la cámara web funciona y no está virtualizada o dañada. Requiere que las siguientes configuraciones estén establecidas en true: record_video.
verify_audio
boolean
Verificará que el micrófono funciona y no está virtualizado o silenciado. Requiere que las siguientes configuraciones estén establecidas en true: record_audio.
verify_desktop
boolean
Verificará que la grabación del escritorio funciona y se está grabando correctamente. Requiere que las siguientes configuraciones estén establecidas en true: record_screen.
verify_id
integer(int32)

0 - La configuración está desactivada.

1 - Requiere que el candidato presente una identificación con foto antes de iniciar el examen, la cual se escaneará automáticamente.

2 - Requiere que el candidato presente una identificación con foto antes de iniciar el examen. La identificación es luego revisada y verificada por un agente de Proctorio antes de que se le permita acceder al examen. Requiere que las siguientes configuraciones estén establecidas en true: record_video, verify_video.

Values are 0, 1, 2.
verify_signature
boolean
Requiere que el candidato firme un acuerdo antes del inicio del examen.
full_screen
integer(int32)

0 - La configuración está desactivada.

1 - Fuerza el examen en pantalla completa, impidiendo el acceso a otras aplicaciones y sitios web. Navegar fuera de la página del examen durante más de 15 segundos (acumulados) resulta en la expulsión del examen. Requiere que las siguientes configuraciones estén establecidas en true: close_tabs, one_screen. Requiere que tabs tenga el valor 1.

2 - Fuerza el examen en pantalla completa, impidiendo el acceso a otras aplicaciones y sitios web. Navegar fuera de la página del examen durante más de 30 segundos (acumulados) resulta en la expulsión del examen. Requiere que las siguientes configuraciones estén establecidas en true: close_tabs, one_screen. Requiere que tabs tenga el valor 1.

3 - Fuerza el examen en pantalla completa, impidiendo el acceso a otras aplicaciones y sitios web. Navegar fuera de la página del examen resulta en la expulsión inmediata del examen. Requiere que las siguientes configuraciones estén establecidas en true: close_tabs, one_screen. Requiere que tabs tenga el valor 1.

Values are 0, 1, 2, 3.
disable_clipboard
boolean
Desactiva la funcionalidad de copiar/pegar.
tabs
integer(int32)

0 - La configuración está desactivada.

1 - Desactiva nuevas pestañas o ventanas durante el examen.

2 - Desactiva nuevas pestañas o ventanas durante el examen excepto los enlaces incrustados en la página del examen.

Values are 0, 1, 2.
close_tabs
boolean
Fuerza el cierre de todas las demás pestañas y ventanas antes de que comience el examen.
one_screen
boolean
Fuerza al candidato a desactivar todos los monitores excepto uno antes de iniciar el examen y les impide conectar monitores adicionales durante el examen.
disable_printing
boolean
Desactiva la impresión del contenido del examen para prevenir la distribución del examen.
block_downloads
boolean
Impide que el candidato descargue archivos a través del navegador.
clear_cache
boolean
Vacía los archivos temporales del sistema después de que el examen sea enviado.
disable_right_click
boolean
Desactiva las funcionalidades del clic derecho.
calculator
integer(int32)

0 - La configuración está desactivada.

1 - Proporciona al candidato una calculadora en pantalla con funciones básicas.

2 - Proporciona al candidato una calculadora en pantalla con funciones científicas.

3 - Proporciona al candidato una calculadora en pantalla con funciones de graficación.

Values are 0, 1, 2, 3.
whiteboard
boolean
Proporciona al candidato un bloc de notas y herramientas de dibujo en pantalla.
disable_extensions
boolean
Impedirá que el candidato utilice otras extensiones del navegador durante el examen, excepto las que estén en la lista de permitidas.
live_proctor
boolean
Esta configuración permitirá a un supervisor monitorizar al candidato durante el examen y permitir una intervención inmediata. Además, la grabación completa y el informe estarán disponibles a través del Review Center de Proctorio. Requiere que las siguientes configuraciones estén establecidas en true: record_video, verify_video.
mobile
boolean
Permite que el examen se realice en un dispositivo móvil, utilizando la aplicación MobileExam. Requiere el uso de pre_auth en la solicitud de lanzamiento. No es compatible con la configuración verify_id: 2
advanced_program_detection
boolean
Impide el uso de otras aplicaciones durante el examen. Requiere el uso de la aplicación Secure Companion.
advanced_hardware_detection
boolean
Registra los cambios de hardware durante el examen en el Review Center. Requiere el uso de la aplicación Secure Companion.
advanced_vm_detection
boolean
Impide el uso de una máquina virtual para realizar el examen. Requiere el uso de la aplicación Secure Companion.
allowed_macos_apps
array[string]
Lista de un máximo de 10 aplicaciones permitidas que pueden permanecer abiertas cuando se utiliza advanced_program_detection. Las aplicaciones se identifican por bundle ID en MacOS.
allowed_windows_apps
array[object]
Lista de un máximo de 10 aplicaciones permitidas que pueden permanecer abiertas cuando se utiliza advanced_program_detection. Las aplicaciones se identifican por binary_name, product_name y company_name en Windows.
Mostrar 3 atributos de allowed_windows_appsOcultar atributos de allowed_windows_apps
binary_name
string
El nombre del binario de la aplicación.
product_name
string
El nombre del producto de la aplicación.
company_name
string
El nombre de la empresa de la aplicación.
strict_apps_validation
integer(int32)

Establece el nivel de rigurosidad para validar las aplicaciones permitidas cuando se utilizan advanced_program_detection, allowed_macos_apps y allowed_windows_apps.

0 - La configuración está desactivada.

1 - Validación predeterminada.

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

El parámetro "domain" es opcional. Al utilizar "domain", las páginas del examen así como el Review Center se cargarán con el dominio deseado.

La URL ya no apuntará a la página https://getproctorio.com. En su lugar, los candidatos/revisores serán dirigidos a la nueva ruta que proporcionó en el parámetro, ejemplo: https://yourdomain.com.

Esto permite la utilización de mecanismos de seguridad de origen cruzado adicionales, que utilizan las cookies SameSite o el encabezado X-Frame-Options: SAMEORIGIN. También proporcionará la capacidad de evitar la pérdida de datos en la sesión o el almacenamiento local relacionada con la funcionalidad de particionamiento de almacenamiento del navegador.

La página https://getproctorio.com tiene las siguientes funcionalidades: Comprobar si un candidato/revisor tiene el navegador compatible instalado. Comprobar si un candidato/revisor tiene la extensión de Proctorio instalada. Para mantener estas funcionalidades, es necesario un enlace a https://getproctorio.com con contenido que describa el propósito de getproctorio.com en la página de la institución.

branding
object
Mostrar 3 atributos de brandingOcultar atributos de branding
primary_color
string
El código de color hexadecimal especifica el color primario para algunos controles de la interfaz de usuario. El valor debe ser un código de seis dígitos, sin el #. Permite a una plataforma de aprendizaje alinear su propio esquema de colores con los colores de Proctorio y destacar su marca en el encabezado. Debe ser un valor de cadena.
Format should match: ^[a-zA-Z0-9]*$.
secondary_color
string
El código de color hexadecimal especifica el color secundario para algunos controles de la interfaz de usuario. El valor debe ser un código de seis dígitos, sin el #. Permite a una plataforma de aprendizaje alinear su propio esquema de colores con los colores de Proctorio y destacar su marca. Debe ser un valor de cadena.
Format should match: ^[a-zA-Z0-9]*$.
logo_url
string
URL del endpoint del logotipo personalizado. Método HTTP: GET. La respuesta debe ser una imagen. Seguro para CORS. La altura del logotipo será de 32px, el ancho es flexible.
user_id
stringObligatorio
Debe contener un valor alfanumérico (también se aceptan guiones), único para este usuario específico.
Format should match: ^[a-zA-Z0-9-]*$.
exam_tag
string
Esta es la etiqueta de ID del examen y se añadirá al final de la URL. El exam_tag no puede contener espacios ni caracteres no ASCII. Si se utiliza, Proctorio lo incluye en la respuesta. Si no se utiliza, se generará una URL sin el hash y la plataforma de aprendizaje deberá añadirlo antes de su uso. Proctorio recomienda utilizar el roster_url cuando no se proporciona el exam_tag.
Format should match: ^(?!goodbye$|support$|update$|setup$|invalid$).*.
section_id
string

Representa un ID de curso o un valor de ID de sección. Este parámetro es opcional. Proporciona una clasificación más detallada de los exámenes.

Esto significa que los exámenes que tienen el mismo "exam_tag" pero diferente "section_id" se tratarán como exámenes diferentes.

El parámetro "section_id" depende del parámetro "roster_url" y no puede utilizarse sin él.

roster_url
string

URL del endpoint del listado de participantes. Método HTTP: GET. La respuesta debe ser un array JSON en formato de cadena. Por ejemplo: '[["id1","name1"],["id2","name2"]]'

El valor "id" debe corresponder al parámetro "userId", ser único para el candidato y no repetirse dentro del listado.

El endpoint del listado es validado por Proctorio, lo que significa que si se proporciona un endpoint no válido o si "userId" no coincide con ningún valor "id" dentro del array, los intentos se marcarán como "Unmatched" en el Review Center.

La roster_url solo es consultada por el usuario final que accede al Review Center o a la página del acuerdo del examen, del lado del cliente, no por Proctorio directamente. Esto significa que puede asegurarse con la sesión de ese usuario en particular. Esto es intencional, y como tal no es necesario que los datos personales se envíen a Proctorio en ningún momento, ya sea en una solicitud de Candidate Launch o de Reviewer Launch.

Respuestas

200application/json

Indica éxito y devuelve una URL de revisor.

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/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);
}
Ejemplos de solicitud
{
  "exam_settings": {
    "record_video": true,
    "record_audio": false,
    "record_screen": false,
    "verify_video": false
  },
  "user_id": "example-id-123"
}