Ir al contenido principal
Integraciones

API y webhooks

Crear una clave de API y qué permite la API pública en un examen en papel: cuadernillos, escaneos, inscritos y calificaciones.

Escrito por Florian Barral

Última actualización Hace 9 días

La API pública permite a sus herramientas (sistema de información, scripts, entorno digital de trabajo) leer sus exámenes en papel, descargar los cuadernillos, enviar los escaneos y obtener las calificaciones. Está reservada a los administradores de la organización.

Crear una clave de API

  1. Haga clic en su nombre en la parte inferior de la barra lateral y luego en Configuración.

  2. En la sección Administración, abra API.

  3. En Claves de API, haga clic en Nueva clave.

  4. Asígnele un Nombre de la clave que le ayude a reconocerla y haga clic en Crear la clave.

  5. Copie el ID de cliente y el Secreto de cliente y haga clic en Guardé mis credenciales.

El secreto de cliente solo se muestra una vez. Guárdelo en un gestor de secretos. Si lo pierde, elimine la clave y cree una nueva.

Una clave da acceso a todos los datos de la organización. Para cortar un acceso, haga clic en Eliminar: las integraciones que usan esa clave dejan de funcionar de inmediato.

Autenticarse

Su herramienta intercambia el ID de cliente y el secreto de cliente por un token de acceso (OAuth 2.0, client_credentials) y lo envía en cada llamada. El enlace Más información de la tarjeta Claves de API abre la documentación completa de la API: direcciones, parámetros y ejemplos.

Qué permite la API en un examen en papel

Necesidad

Con la API

Encontrar sus exámenes en papel

Listar los exámenes filtrando por el tipo paper.

Inscribir a los participantes

Añadir, modificar o retirar inscritos, hasta 50 por llamada. No se les envía ningún correo electrónico.

Seguir la preparación de los cuadernillos

Leer el tipo de cuadernillo (nominativo o anónimo), el número de cuadernillos y el estado de la generación.

Descargar los cuadernillos

Obtener el PDF de todos los cuadernillos, de cuadernillos individuales, de las hojas de respuestas o de las hojas de preguntas, una vez generados.

Importar los escaneos

Enviar un PDF de escaneos (20 MB como máximo por archivo). Las importaciones se van sumando y el análisis se realiza igual que en la aplicación.

Obtener las calificaciones

Leer la calificación final de cada participante.

Cree el examen, configure los cuadernillos y lance su generación en Papeez: la API lee ese estado y sirve los archivos, pero no crea exámenes en papel. Las páginas que el análisis no ha podido asociar a un participante se tratan en Papeez: consulte Importar los escaneos.

Webhooks

En la misma página, la tarjeta Webhooks envía a sus servidores los eventos de su organización en el momento en que se producen: Nuevo webhook, luego la URL de destino (en https) y los Eventos que recibir. En un examen en papel, los eventos útiles son los relacionados con los correos enviados a los participantes (envío, recepción, apertura…). Todavía no hay eventos para los escaneos ni las calificaciones: consulte la API para seguir el análisis de los escaneos.

Las claves de API están disponibles con todos los planes. Los webhooks no están incluidos en todos los planes: si es el caso del suyo, Papeez lo indica al crearlos.

Preguntas frecuentes

La sección Administración de la configuración está reservada a los administradores de la organización.

En un examen con cuadernillos anónimos, inscriba primero a los participantes: Papeez necesita la lista de inscritos para encontrar cada cuadernillo. Consulte Cuadernillos nominativos o anónimos.

Los archivos solo existen una vez generados los cuadernillos en Papeez. Consulte Generar los cuadernillos para imprimir.