API REST
Labvanced propose une API REST permettant aux utilisateurs de récupérer des données depuis le serveur Labvanced, après que le(s) participant(s) ait/aient complété l'étude.
L'API REST est authentifiée avec un token, qui vous permet de télécharger toutes vos données de manière programmatique. L'API REST est idéale pour les organisations et les institutions de recherche académique qui souhaitent centraliser leur récupération de données et stocker leurs données à des endroits dédiés selon leur protocole de pipeline. Au lieu de sélectionner et de télécharger des données manuellement et de les enregistrer localement, cela permet aux organisations d'accéder aux données sur leurs serveurs, ce qui est également important pour le protocole GDPR.
La documentation (Swagger UI) des points de terminaison rest se trouve ici : https://www.labvanced.com/openapi.html
Nous fournissons également une spécification openapi qui peut être utilisée pour générer automatiquement du code client pour différents langages de programmation (c'est-à-dire dans des outils comme Postman) : https://www.labvanced.com/labvanced-openapi.json
Création du Token API
Il s'agit d'une API sécurisée, ce qui signifie que vous devez valider l'accès à l'aide d'un token généré dans Labvanced pour accéder aux données.
Pour créer le token, connectez-vous à l'application Labvanced et allez à l'onglet 'Mon compte' situé sur le côté gauche du menu.
Il y a une section appelée 'Informations d'identification API' et pour créer le token, il suffit de cliquer sur 'Générer.'
Lorsque le token apparaît, double-cliquez sur la clé du token pour tout mettre en surbrillance, puis Ctrl+C pour le copier.
Avec ce token, vous pourrez accéder aux données de vos études et des sessions pertinentes.
Note : le token ne peut être généré que pour donner accès aux données de session par le propriétaire de l'étude.
Essayez-le en utilisant notre documentation API (Swagger UI)
Le moyen le plus simple de tester notre API est d'utiliser la fonctionnalité "Essayez-le" dans notre documentation API (Swagger UI) : https://www.labvanced.com/openapi.html
Dans le coin supérieur droit, vous cliquez sur 'Autoriser'.
Cela ouvrira une boîte de dialogue vous demandant d'entrer / coller le token dans le champ 'Valeur'.
Une fois que vous avez collé le token, cliquez sur 'Autoriser' puis sur 'Fermer' pour fermer la boîte de dialogue.
Note : Lorsque vous avez fini de regarder les données, vous pouvez vous déconnecter de cette session en cliquant sur 'Autoriser' trouvé dans le coin supérieur droit du site Web, puis, dans la boîte de dialogue qui apparaît, en cliquant sur le bouton 'Déconnexion' qui apparaît dans le coin inférieur gauche.
Essayez d'accéder aux données via notre documentation API
Une fois connecté, vous pouvez utiliser ces deux zones pour accéder à vos données expérimentales :
- /api/{expId}/download/{recSessionId} : cette section vous permet d'accéder et de télécharger les données d'un seul participant. Lorsque les données sont téléchargées, elles seront au format de fichier .csv selon la configuration que vous avez spécifiée dans les exportSettings trouvés sur la page ‘Vue des données & Export’ dans l'application Labvanced.
- /api/{expId}/sessions : permet de récupérer toutes les sessions pour une expérience spécifique en entrant l'‘id de l'expérience.’
Données de ‘/api/{expId}/sessions’
Il est préférable de commencer par le deuxième point de terminaison pour d'abord découvrir quelles sessions d'enregistrement (et leur rec_session_id correspondant) existent dans une expérience donnée. Cliquez sur le deuxième champ bleu étiqueté /api/{expId}/sessions et cela s'ouvrira dans une vue plus grande et cliquez sur le bouton 'Essayez-le' sur le côté droit :
En cliquant sur 'Essayez-le', vous pourrez entrer des chiffres dans le champ 'expid' pour indiquer l'identifiant de l'expérience pour laquelle vous souhaitez accéder aux données de session. Vous pouvez trouver cela dans Labvanced sur la page "Mes études" dans la colonne "ID". Une fois que vous avez rempli ce champ, cliquez sur 'Exécuter'.
Une fois cela fait, vous pouvez faire défiler vers le bas et voir les informations pour toutes les sessions dans cette expérience spécifique :
Veuillez noter l'un des rec_session_id
du payload de réponse à utiliser dans la section suivante pour télécharger toutes les données enregistrées de cette session d'enregistrement.
Note : Pour entrer un 'identifiant d'expérience' différent, il suffit de cliquer sur le bouton rouge 'Annuler' sur le côté droit, afin de pouvoir entrer un nouvel 'identifiant d'expérience.'
Données de ‘recSessionId’
Pour accéder et télécharger les données d'un participant, cliquez sur le premier champ bleu étiqueté /api/{expId}/download/{recSessionId} et cela s'ouvrira dans une vue plus grande et cliquez sur le bouton 'Essayez-le' sur le côté droit :
En cliquant sur 'Essayez-le', vous pourrez entrer des chiffres dans les deux champs qui apparaissent en indiquant l'‘identifiant d'expérience’ et le ‘rec_session_id’ que vous souhaitez télécharger (voir section précédente).
Une fois que vous avez entré ces valeurs, il suffit de cliquer sur 'Exécuter' et l'API s'exécutera. Ensuite, faites défiler vers le bas, et vous verrez une option pour 'Télécharger le fichier.'
En cliquant sur 'Télécharger le fichier', un fichier .zip sera téléchargé contenant deux fichiers .csv, à savoir :
- sessions.csv
- trials.csv
Ces fichiers contiendront toutes les données pertinentes pour la session spécifique et les données des essais associées.
Note : Pour récupérer une session différente, il suffit de cliquer sur le bouton rouge 'Annuler' sur le côté droit, afin de pouvoir entrer un nouvel 'identifiant d'expérience' et un nouvel 'rec_session_id' à télécharger.
En conclusion, ces étapes vous permettent d'accéder aux données en utilisant le token API que vous avez généré en utilisant un token unique et sécurisé dans Labvanced afin de consulter les données expérimentales et de session.
Essayez-le en utilisant Postman
Ceci est une seconde option pour essayer l'API pour ceux qui utilisent déjà Postman (une plateforme API) dans leurs activités quotidiennes. Le token API Labvanced fonctionne également à partir de là.
Vous entrez l'URL dans le champ supérieur, basée sur le site Web de l'API Labvanced.
Ensuite, sélectionnez la clé et collez le token sous la colonne ‘valeur’, comme montré ci-dessous :
De cette façon, les données de session pour une expérience seront accessibles via Postman.
De même, vous pouvez suivre le même processus afin de télécharger des fichiers pour un participant spécifique.
En faisant cela, l'aperçu affichera des caractères étranges mais c'est normal car cette commande est destinée à récupérer des fichiers. Lorsque vous cliquez sur 'Enregistrer les réponses' et 'Enregistrer dans un fichier', les données pour le participant particulier apparaîtront normalement.