authentication_guide

# LabArchives 身份验证指南 ## 先决条件 ### 1. 企业版许可证 API 访问需要 LabArchives 企业版许可证。请联系您的 LabArchives 管理员或发送邮件至 [email protected] 以： - 验证您的机构是否拥有企业版访问权限 - 请求为您的账户启用 API 访问权限 - 获取机构 API 凭据 ### 2. API 凭据 您需要两组凭据： #### 机构 API 凭据（从 LabArchives 管理员处获取） - **访问密钥 ID (Access Key ID)**: 机构级标识符 - **访问密码 (Access Password)**: 机构级密钥 #### 用户身份验证凭据（自行配置） - **电子邮件**: 您的 LabArchives 账户电子邮件（例如 [email protected]） - **外部应用程序密码**: 在您的 LabArchives 账户设置中设置 ## 设置外部应用程序密码 外部应用程序密码不同于您的常规 LabArchives 登录密码。它允许在不暴露主凭据的情况下进行 API 访问。 **创建外部应用程序密码的步骤：** 1. 登录您的 LabArchives 账户 (mynotebook.labarchives.com 或您的机构 URL) 2. 导航至 **账户设置 (Account Settings)**（点击右上角的姓名） 3. 选择 **安全与隐私 (Security & Privacy)** 选项卡 4. 找到 **外部应用程序 (External Applications)** 部分 5. 点击 **生成新密码 (Generate New Password)** 或 **重置密码 (Reset Password)** 6. 复制并安全存储此密码（之后将无法再次查看） 7. 将此密码用于所有 API 身份验证 **安全提示：** 请像对待 API 令牌一样对待此密码。如果泄露，请立即从账户设置中重新生成。 ## 配置文件设置 创建一个 `config.yaml` 文件以安全存储您的凭据： yaml # 区域 API 端点 api_url: https://api.labarchives.com/api # 机构凭据（从管理员处获取） access_key_id: YOUR_ACCESS_KEY_ID_HERE access_password: YOUR_ACCESS_PASSWORD_HERE # 用户凭据（用于用户特定操作） user_email: [email protected] user_external_password: YOUR_EXTERNAL_APP_PASSWORD_HERE **替代方案：环境变量** 为了增强安全性，请使用环境变量代替配置文件： bash export LABARCHIVES_API_URL="https://api.labarchives.com/api" export LABARCHIVES_ACCESS_KEY_ID="your_key_id" export LABARCHIVES_ACCESS_PASSWORD="your_access_password" export LABARCHIVES_USER_EMAIL="[email protected]" export LABARCHIVES_USER_PASSWORD="your_external_app_password" ## 区域端点 选择正确的区域 API