REST API
Labvanced为用户提供了一个REST API,以便在参与者完成研究后从Labvanced服务器获取数据。
该REST API使用令牌进行身份验证,允许您以编程方式下载所有数据。对于希望集中获取数据并根据其管道协议将数据存储在专用位置的组织和学术研究机构而言,REST API非常理想。通过这种方式,组织可以在其服务器上访问数据,这对于GDPR协议也很重要,而不是手动选择和下载数据并将其保存在本地。
REST端点的文档(Swagger UI)可以在此找到: https://www.labvanced.com/openapi.html
我们还提供了一个openapi规范,可用于自动生成不同编程语言的客户端代码(例如在Postman等工具中): https://www.labvanced.com/labvanced-openapi.json
创建API令牌
这是一个安全的API,这意味着您需要验证在Labvanced中生成的令牌以访问数据。
要创建令牌,请登录Labvanced应用并转到菜单左侧的“我的帐户”选项卡。
有一个名为“API凭据”的部分,要创建令牌,只需点击“生成”。
当令牌出现时,双击令牌键以突出显示它,然后按Ctrl+C复制。
有了这个令牌,您将能够访问您的研究和相关会话的数据。
注意: 令牌只能由研究所有者生成,以便访问会话数据。
使用我们的API文档(Swagger UI)尝试
尝试我们API最简单的方法是使用我们的API文档(Swagger UI)中的“尝试”功能: https://www.labvanced.com/openapi.html
在右上角,您点击“授权”。
这将打开一个对话框,要求您在“值”字段中输入/粘贴令牌。
一旦您粘贴令牌,点击“授权”,然后点击“关闭”以关闭对话框。
注意: 当您查看完数据后,可以通过点击网站右上角的“授权”,然后在出现的对话框中点击左下角的“注销”按钮来退出此会话。
通过我们的API文档尝试访问数据
登录后,您可以使用这两个区域来访问您的实验数据:
- /api/{expId}/download/{recSessionId}: 该部分允许您访问和下载单个参与者的数据。下载的数据将根据您在Labvanced应用的“数据视图与导出”页面的exportSettings中指定的配置以.csv文件格式保存。
- /api/{expId}/sessions: 通过输入“实验ID”,允许您检索特定实验的所有会话。
数据来自‘/api/{expId}/sessions’
最好从第二个端点开始,首先找出给定实验中存在哪些录制会话(及其相应的rec_session_id)。 您点击标记为 /api/{expId}/sessions 的第二个蓝色字段,它将打开一个更大的视图,点击右侧的“尝试”按钮:
通过点击“尝试”,您将能够在“expid”字段中输入数字,以指示要访问会话数据的实验ID。您可以在Labvanced的“我的研究”页面的“ID”列中找到此项。填好此字段后,点击“执行”。
执行后,您可以向下滚动,查看该特定实验中所有会话的信息:
请记下响应负载中的一个rec_session_id
以便在下一部分下载该录制会话的所有录制数据。
注意: 要输入不同的“实验ID”,只需点击右侧的红色“取消”按钮,以便能够输入新的“实验ID”。
数据来自‘recSessionId’
要访问和下载参与者的数据,您点击第一个蓝色字段标记为 /api/{expId}/download/{recSessionId},它将打开一个更大的视图,点击右侧的“尝试”按钮:
通过点击“尝试”,您将能够在出现的两个字段中输入指定的“实验ID”和您想要下载的“rec_session_id”(见上一部分)。
输入这些值后,只需点击“执行”,API将运行。然后您向下滚动,您将看到“下载文件”的选项。
点击“下载文件”后,将下载一个包含两个.csv文件的.zip文件,分别是:
- sessions.csv
- trials.csv
这些文件将包含特定会话及其相关试验数据的所有相关数据。
注意: 要获取不同的会话,只需点击右侧的红色“取消”按钮,以便能够输入新的“实验ID”和新的“rec_session_id”进行下载。
总之,这些步骤允许您使用在Labvanced中生成的唯一安全令牌访问数据,以查看实验和会话数据。
使用Postman尝试
这是第二种尝试API的选项,对于那些在日常活动中已经使用Postman(一个API平台)的人来说,Labvanced API令牌同样有效。
您在顶部字段输入URL,基于Labvanced API网站。
然后,选择密钥并在“值”列下粘贴令牌,如下所示:
通过这种方式,实验的会话数据将通过Postman可访问。
同样,您可以按照相同的流程为特定参与者下载文件。
在执行此操作时,预览将显示奇怪的字符,但这很正常,因为此命令是用于获取文件。当您点击“保存响应”和“保存到文件”时,特定参与者的数据将正常显示。