REST API
Labvanced bietet eine REST API für Benutzer, um Daten vom Labvanced-Server abzurufen, nachdem die Teilnehmer die Studie abgeschlossen haben.
Die REST API ist mit einem Token authentifiziert, das es Ihnen ermöglicht, alle Ihre Daten programmatisch herunterzuladen. Die REST API ist ideal für Organisationen und akademische Forschungseinrichtungen, die ihre Datenerfassung zentralisieren und ihre Daten an dedizierten Orten gemäß ihrem Pipeline-Protokoll speichern möchten. Anstatt Daten manuell auszuwählen und lokal zu speichern, ermöglicht es Organisationen, auf die Daten auf ihren Servern zuzugreifen, was auch für das GDPR-Protokoll wichtig ist.
Die Dokumentation (Swagger UI) der REST-Endpunkte finden Sie hier: https://www.labvanced.com/openapi.html
Wir bieten auch eine OpenAPI-Spezifikation an, die verwendet werden kann, um automatisch Client-Code für verschiedene Programmiersprachen (d.h. in Tools wie Postman) zu generieren: https://www.labvanced.com/labvanced-openapi.json
Erstellen des API-Tokens
Dies ist eine gesicherte API, was bedeutet, dass Sie den Zugriff mit einem in Labvanced generierten Token validieren müssen, um auf die Daten zuzugreifen.
Um das Token zu erstellen, melden Sie sich in der Labvanced-App an und gehen Sie zum Tab „Mein Konto“, der sich auf der linken Seite des Menüs befindet.
Es gibt einen Abschnitt mit dem Titel „API-Anmeldeinformationen“, und um das Token zu erstellen, klicken Sie einfach auf „Generieren“.
Wenn das Token erscheint, doppelklicken Sie auf den Token-Schlüssel, um ihn zu markieren, und kopieren Sie ihn dann mit Strg+C.
Mit diesem Token können Sie auf die Daten Ihrer Studien und der relevanten Sitzungen zugreifen.
Hinweis: Das Token kann nur vom Studieninhaber generiert werden, um Zugang zu den Sitzungsdaten zu gewähren.
Testen Sie es mit unserer API-Dokumentation (Swagger UI)
Der einfachste Weg, unsere API auszuprobieren, ist die Verwendung der Funktion "Try it out" in unserer API-Dokumentation (Swagger UI): https://www.labvanced.com/openapi.html
Oben rechts klicken Sie auf „Autorisieren“.
Dies öffnet ein Dialogfeld, das Sie auffordert, das Token im Feld „Wert“ einzugeben / einzufügen.
Sobald Sie das Token eingefügt haben, klicken Sie auf „Autorisieren“ und dann auf „Schließen“, um das Dialogfeld zu schließen.
Hinweis: Wenn Sie mit der Datenansicht fertig sind, können Sie sich von dieser Sitzung abmelden, indem Sie auf „Autorisieren“ oben rechts auf der Website klicken und dann im Dialogfeld, das erscheint, auf die Schaltfläche „Abmelden“ klicken, die unten links erscheint.
Testen Sie den Zugriff auf Daten über unsere API-Dokumentation
Sobald Sie angemeldet sind, können Sie diese beiden Bereiche nutzen, um auf Ihre Experimentaldaten zuzugreifen:
- /api/{expId}/download/{recSessionId}: Dieser Abschnitt ermöglicht den Zugriff auf und das Herunterladen der Daten eines einzelnen Teilnehmers. Wenn die Daten heruntergeladen werden, erfolgt dies im .csv-Format entsprechend der Konfiguration, die Sie in den exportSettings auf der Seite „Dataview & Export“ in der Labvanced-App angegeben haben.
- /api/{expId}/sessions: ermöglicht es Ihnen, alle Sitzungen für ein bestimmtes Experiment abzurufen, indem Sie die „Experiment-ID“ eingeben.
Daten von ‘/api/{expId}/sessions’
Es ist am besten, mit dem zweiten Endpunkt zu beginnen, um zuerst herauszufinden, welche Aufzeichnungssitzungen (und deren zugehörige rec_session_id) in einem bestimmten Experiment existieren. Klicken Sie auf das zweite blaue Feld mit der Bezeichnung /api/{expId}/sessions, und es öffnet sich eine größere Ansicht. Klicken Sie auf die Schaltfläche „Try it out“ auf der rechten Seite:
Durch Klicken auf „Try it out“ können Sie Zahlen in das Feld „expid“ eingeben, um die Experiment-ID anzugeben, für die Sie die Sitzungsdaten abrufen möchten. Sie finden dies in Labvanced auf der Seite „Meine Studien“ in der Spalte „ID“. Sobald Sie dieses Feld ausgefüllt haben, klicken Sie auf „Execute“.
Sobald Sie dies tun, können Sie nach unten scrollen und die Informationen zu allen Sitzungen in diesem speziellen Experiment sehen:
Bitte notieren Sie sich eine der rec_session_id
aus der Antwort-Nutzlast, um sie im nächsten Abschnitt zu verwenden, um alle aufgezeichneten Daten dieser Aufzeichnungssitzung herunterzuladen.
Hinweis: Um eine andere „Experiment-ID“ einzugeben, klicken Sie einfach auf die rote Schaltfläche „Abbrechen“ auf der rechten Seite, um eine neue „Experiment-ID“ eingeben zu können.
Daten von ‘recSessionId’
Um auf die Daten eines Teilnehmers zuzugreifen und sie herunterzuladen, klicken Sie auf das erste blaue Feld mit der Bezeichnung /api/{expId}/download/{recSessionId} und es öffnet sich eine größere Ansicht. Klicken Sie auf die Schaltfläche „Try it out“ auf der rechten Seite:
Durch Klicken auf „Try it out“ können Sie Zahlen in die beiden Felder eingeben, die erscheinen, und die „Experiment-ID“ und die „rec_session_id“ angeben, die Sie herunterladen möchten (siehe vorheriger Abschnitt).
Sobald Sie diese Werte eingegeben haben, klicken Sie einfach auf „Execute“, und die API wird ausgeführt. Dann scrollen Sie nach unten, und Sie sehen eine Option zum „Datei herunterladen“.
Durch Klicken auf „Datei herunterladen“ wird eine .zip-Datei heruntergeladen, die zwei .csv-Dateien enthält, nämlich:
- sessions.csv
- trials.csv
Diese Dateien enthalten alle relevanten Daten für die spezifische Sitzung und die zugehörigen Versuchsdaten.
Hinweis: Um eine andere Sitzung abzurufen, klicken Sie einfach auf die rote Schaltfläche „Abbrechen“ auf der rechten Seite, um eine neue „Experiment-ID“ und eine neue „rec_session_id“ zum Herunterladen eingeben zu können.
Zusammenfassend ermöglichen Ihnen diese Schritte, mithilfe des API-Tokens, das Sie mit einem einzigartigen und gesicherten Token in Labvanced generiert haben, auf experimentelle und Sitzungsdaten zuzugreifen.
Testen Sie es mit Postman
Dies ist eine zweite Option, um die API auszuprobieren, für diejenigen, die bereits Postman (eine API-Plattform) in ihrem täglichen Geschäft verwenden. Das Labvanced API-Token funktioniert auch dort.
Geben Sie die URL im oberen Feld ein, basierend auf der Labvanced API-Website.
Dann wählen Sie Schlüssel und fügen Sie das Token unter der Spalte „Wert“ ein, wie unten gezeigt:
Auf diese Weise sind die Sitzungsdaten für ein Experiment über Postman zugänglich.
Ebenso können Sie denselben Prozess folgen, um Dateien für einen bestimmten Teilnehmer herunterzuladen.
Wenn Sie dies tun, zeigt die Vorschau seltsame Zeichen an, aber das ist normal, da dieser Befehl für das Abrufen von Dateien gedacht ist. Wenn Sie auf „Antworten speichern“ und „In einer Datei speichern“ klicken, erscheinen die Daten für den betreffenden Teilnehmer normal.