用途:通过 LabArchives REST API 实现电子实验记录本的自动化操作,适用于记录本备份、条目与附件管理、数据上传、站点报告生成及与第三方科研工具的集成。
主要能力:认证与配置(设置 API 凭证和区域端点);用户信息获取;记录本操作(列出、备份、获取 ID 与成员、设置);条目与附件管理(创建条目、添加注释、上传附件);站点报告与分析(企业版功能,如使用报告、记录本报告等);第三方集成(Protocols.io、Jupyter、REDCap 等)。
使用方式:需企业版 LabArchives 许可并启用 API,获取访问密钥与密码。运行 python3 scripts/setup_config.py 生成 config.yaml,配置 api_url、access_key_id、access_password。区域端点:美国/国际 https://api.labarchives.com/api,澳大利亚 https://auapi.labarchives.com/api,英国 https://ukapi.labarchives.com/api。示例脚本:python3 scripts/notebook_operations.py backup --uid USER_ID --nbid NOTEBOOK_ID(支持 --json、--no-attachments);python3 scripts/entry_operations.py upload --uid USER_ID --nbid NOTEBOOK_ID --entry-id ENTRY_ID --file /path/to/file.pdf;entry_operations.py create 创建条目。报告调用如 client.make_call('site_reports', 'detailed_usage_report', params={'start_date': '2025-01-01', 'end_date': '2025-10-20'})。可安装 labarchives-py:git clone https://github.com/mcmero/labarchives-py,cd labarchives-py,uv pip install .
适用场景:记录本批量备份、数据自动上传、合规性报告、科研数据管理集成。
限制:需企业版许可及管理员提供的 API 凭证;新集成采用 OAuth,旧版可能用 API 密钥;存在速率限制,需处理延迟与错误;附件有大小和格式限制;部分报告为企业版功能。常见错误:401 未授权、404 未找到、403 禁止、空响应等。联系方式:support@labarchives.com。