Labarchive Integration API 参考

# LabArchives API 参考 ## API 结构 所有 LabArchives API 调用均遵循此 URL 模式： https:///api//?& ## 区域 API 端点 | 区域 | 基础 URL | |--------|----------| | 美国/国际 | `https://api.labarchives.com/api` | | 澳大利亚 | `https://auapi.labarchives.com/api` | | 英国 | `https://ukapi.labarchives.com/api` | ## 身份验证 所有 API 调用都需要身份验证参数： - `access_key_id`: 由 LabArchives 管理员提供 - `access_password`: 由 LabArchives 管理员提供 - 某些操作可能需要额外的用户特定凭据 ## API 类与方法 ### Users API 类 #### `users/user_access_info` 检索用户 ID 和记录本访问信息。 **参数：** - `login_or_email` (必需): 用户的电子邮件地址或登录用户名 - `password` (必需): 用户的外部应用程序密码（非常规登录密码） **返回：** 包含以下内容的 XML 或 JSON 响应： - 用户 ID (uid) - 可访问的记录本列表及其 ID (nbid) - 账户状态和权限 **示例：** python params = { 'login_or_email': '[email protected]', 'password': 'external_app_password' } response = client.make_call('users', 'user_access_info', params=params) #### `users/user_info_via_id` 通过用户 ID 检索详细用户信息。 **参数：** - `uid` (必需): 从 user_access_info 获取的用户 ID **返回：** 用户资料信息，包括： - 姓名和电子邮件 - 账户创建日期 - 所属机构 - 角色和权限 - 存储配额和使用情况 **示例：** python params = {'uid': '12345'} response = client.make_call('users', 'user_info_via_id', params=params) ### Notebooks API 类 #### `notebooks/notebook_backup` 下载完整的记录本数据，包括条目、附件和元数据。 **参数：** - `uid` (必需): 用户 ID - `nbid` (必需): 记录本 ID - `json` (可选，默认: false): 以 JSON 格式而非 XML 返回数据 - `no_attachments` (可选，默认: false): 备份时排除附件 **返回：** - 当 `no_attachments=false` 时：包含所有记录本数据的 7z 压缩归档文件 - 当 `no_attachments=true` 时：包含条目内容的 XML 或 JSON 结构化数据 **文件格式：** 返回的归档文件包括： - HTML 格式的条目文本内容 - 原始格式的文件附件 - 带有时间戳的元数据 XML 文件