API REST
Labvanced ofrece una API REST para que los usuarios obtengan datos del servidor de Labvanced, después de que el(los) participante(s) hayan completado el estudio.
La API REST está autenticada con un token, que le permite descargar todos sus datos programáticamente. La API REST es excelente para organizaciones e instituciones de investigación académica que desean centralizar la obtención de datos y almacenar sus datos en lugares dedicados de acuerdo con su protocolo de pipeline. En lugar de seleccionar y descargar datos manualmente y guardarlos localmente, esto permite a las organizaciones acceder a los datos en sus servidores, lo cual también es importante para el protocolo GDPR.
La documentación (Swagger UI) de los puntos finales REST se puede encontrar aquí: https://www.labvanced.com/openapi.html
También proporcionamos una especificación openapi que se puede utilizar para autogenerar código de cliente para diferentes lenguajes de programación (es decir, en herramientas como Postman): https://www.labvanced.com/labvanced-openapi.json
Creando el Token de API
Esta es una API segura, lo que significa que necesita validar el acceso utilizando un token generado en Labvanced para acceder a los datos.
Para crear el token, inicie sesión en la aplicación Labvanced y vaya a la pestaña ‘Mi Cuenta’ ubicada en el lado izquierdo del menú.
Hay una sección llamada ‘Credenciales API’ y para crear el token, simplemente haga clic en ‘Generar.’
Cuando aparezca el token, haga doble clic en la clave del token para resaltarla toda y luego Ctrl+C para copiarla.
Con este token, podrá acceder a los datos de sus estudios y las sesiones relevantes.
Nota: el token solo puede ser generado para dar acceso a los datos de la sesión por el propietario del estudio.
Pruébelo usando nuestra Documentación de API (Swagger UI)
La forma más sencilla de probar nuestra API es usar la funcionalidad "Pruébalo" en nuestra documentación de API (Swagger UI): https://www.labvanced.com/openapi.html
En la esquina superior derecha, haga clic en ‘Autorizar’.
Esto abrirá un cuadro de diálogo que le solicita que ingrese / pegue el token en el campo ‘Valor’.
Una vez que pegue el token, haga clic en ‘Autorizar’ y luego en ‘Cerrar’ para cerrar el cuadro de diálogo.
Nota: Cuando haya terminado de ver los datos, puede cerrar sesión en esta sesión haciendo clic en ‘Autorizar’ que se encuentra en la esquina superior derecha del sitio web y luego, en el cuadro de diálogo que aparece, haciendo clic en el botón ‘Cerrar sesión’ que aparece en la esquina inferior izquierda.
Pruebe el Acceso a los Datos a través de nuestra Documentación de API
Una vez que haya iniciado sesión, puede utilizar estas dos áreas para acceder a sus datos experimentales:
- /api/{expId}/download/{recSessionId}: esta sección le permite acceder y descargar los datos de un solo participante. Cuando se descarguen los datos, estarán en un formato de archivo .csv según la configuración que haya especificado en los exportSettings que se encuentran en la página ‘Vista de Datos & Exportar’ en la aplicación Labvanced.
- /api/{expId}/sessions: le permite recuperar todas las sesiones de un experimento específico ingresando el ‘id del experimento’.
Datos de ‘/api/{expId}/sessions’
Es mejor comenzar con el segundo endpoint para primero averiguar qué sesiones de grabación (y su correspondiente rec_session_id) existen en un experimento dado. Haga clic en el segundo campo azul etiquetado /api/{expId}/sessions y se abrirá en una vista más grande; luego haga clic en el botón ‘Pruébalo’ en el lado derecho:
Al hacer clic en ‘Pruébalo’, podrá ingresar números en el campo ‘expid’ para indicar el id del experimento para el cual desea acceder a los datos de la sesión. Puede encontrar esto en Labvanced en la página "Mis Estudios" en la columna "ID". Una vez que complete este campo, haga clic en ‘Ejecutar.’
Una vez hecho esto, puede desplazarse hacia abajo y ver la información de todas las sesiones en ese experimento específico:
Por favor, anote uno de los rec_session_id
de la carga útil de respuesta para usarlo en la siguiente sección para descargar todos los datos grabados de esa sesión de grabación.
Nota: Para ingresar un ‘id de experimento’ diferente, simplemente haga clic en el botón rojo ‘Cancelar’ en el lado derecho, para poder ingresar un nuevo ‘id de experimento.’
Datos de ‘recSessionId’
Para acceder y descargar los datos de un participante, haga clic en el primer campo azul etiquetado /api/{expId}/download/{recSessionId} y se abrirá en una vista más grande; luego haga clic en el botón ‘Pruébalo’ en el lado derecho:
Al hacer clic en ‘Pruébalo’, podrá ingresar números en los dos campos que aparecen indicando el ‘id del experimento’ y el ‘rec_session_id’ que desea descargar (ver sección anterior).
Una vez que ingrese estos valores, simplemente haga clic en ‘Ejecutar’ y la API se ejecutará. Luego se desplaza hacia abajo y verá una opción para ‘Descargar archivo.’
Al hacer clic en ‘Descargar archivo’, se descargará un archivo .zip que contiene dos archivos .csv, a saber:
- sessions.csv
- trials.csv
Estos archivos contendrán todos los datos relevantes para la sesión específica y los datos de ensayos asociados.
Nota: Para obtener una sesión diferente, simplemente haga clic en el botón rojo ‘Cancelar’ en el lado derecho, para poder ingresar un nuevo ‘id de experimento’ y un nuevo ‘rec_session_id’ para descargar.
En conclusión, estos pasos le permiten acceder a los datos utilizando el token de API que ha generado utilizando un token único y seguro en Labvanced para ver los datos experimentales y de sesiones.
Pruébelo usando Postman
Esta es una segunda opción para probar la API para aquellos que ya están utilizando Postman (una plataforma API) en sus actividades diarias. El token de API de Labvanced también funciona desde allí.
Ingrese la URL en el campo superior, basado en el sitio web de la API de Labvanced.
Luego, seleccione la Clave y pegue el token en la columna ‘valor’, como se muestra a continuación:
De esta manera, los datos de sesión de un experimento serán accesibles a través de Postman.
Del mismo modo, puede seguir el mismo proceso para descargar archivos para un participante específico.
Al hacerlo, la vista previa mostrará caracteres extraños, pero esto es normal porque este comando es para obtener archivos. Cuando haga clic en ‘Guardar Respuestas’ y ‘Guardar en un archivo’, los datos del participante en particular aparecerán normalmente.