使用 Box® 连接器,您可以 使用命令 与 Box 驱动器进行交互,例如:
- 搜索和管理文件
- 创建和删除文件夹
- 获取文件和文件夹的 URL
注: 此连接器由 Workiva 构建,并连接到第三方系统。虽然我们的支持团队可以帮助您在工作区内配置此连接器,但我们无法对源自 Workiva 平台之外的任何问题进行故障排除或提供其他帮助。
先决条件
要设置连接器,您需要:
- 用于服务帐户集成的自定义 Box 应用
- 自定义应用程序的企业 ID、客户端 ID 和密钥以及私钥
在 Box 中创建服务帐户集成
在设置 Box 连接器之前,请为服务帐户集成创建一个自定义 Box 应用。要配置应用程序的公钥/私钥对,您需要:
- OpenSSL
- 纯文本编辑器,例如 Windows 记事本
- Box 中已启用双因素身份验证 (2FA)。
步骤 1:创建自定义 Box 应用程序
- 从 开发者控制台中的 [] 框中,单击 创建新应用。
- 选择 自定义应用,然后单击 下一步。
- 在 身份验证方法下,选择 使用 JWT 的 OAuth 2.0,然后单击 下一步。
- 输入一个唯一的名称以帮助识别该应用程序,例如 Workiva Box 应用程序,然后单击 创建应用程序 ,再单击 查看您的应用程序。
步骤 2:创建应用程序的 RSA 密钥对
为了确保连接安全,Box 连接器使用自定义应用程序的 Rivest-Shamir-Adleman (RSA) 公钥/私钥对进行身份验证。要在 OpenSSL中创建此密钥对,请输入以下命令:
openssl genrsa -out private.pem 2048
openssl rsa -in private.pem -outform PEM -pubout -out public.pem
这些命令会生成两个文件:
-
private.pem中包含连接器用于向 Box 进行身份验证的客户端密钥。 -
public.pem,自定义应用程序配置需要此文件。
步骤 3:配置自定义应用程序
- 从 Box 中的 Dev Console中选择 Configuration 以配置自定义应用程序。
- 在 身份验证方法下,选择验证 OAuth 2.0 with JWT 。
- 在 “应用程序访问”下,选择 “企业” ,然后单击 “保存更改” 。
- 在纯文本编辑器中,打开
public.pem文件,并复制其全部内容,包括标题行-----BEGIN PUBLIC KEY-----、页脚行-----END PUBLIC KEY-----和任何尾随空格。 - 在 Box 的 开发者控制台 中,选择自定义应用程序的配置 ,然后单击 添加和管理公钥[] 下的 添加公钥 []。
- 粘贴
public.pem文件中的全部内容,然后单击 验证并保存。 - 出现提示时,输入您的 Box 帐户的 2FA 代码,然后单击 提交。
- 在 OAuth 2.0 凭据下,复制自定义应用程序的客户端 ID。
步骤 4:在 Box 中授权自定义应用
- 从 管理控制台 中的框中,单击 应用。
- 在 自定义应用 选项卡上,单击 授权新应用。
- 粘贴自定义应用程序的客户端 ID,然后单击 下一步。
- 在 应用授权下,验证该应用是否已获得所有用户的授权,然后点击 授权。
步骤 5:将服务帐户 ID 添加为 Box 文件夹的协作者
- 从 Box 中的 Dev Console中选择 Configuration 以配置自定义应用程序。
- 复制服务账号。
- 进入要共享的 Box 文件夹。在“共享”下,找到“协作者”部分,然后单击 邀请人员 添加服务帐户 ID。
设置盒子连接器
注: 要使连接器可在您组织的链中使用, 组织安全管理员首先需要在配置中启用它。
- 从 链构建器中,单击 连接,然后单击右上角的 创建 。
- 在 连接器连接下,选择 盒子 和默认的 CloudRunner。
- 在 基本信息下,输入一个唯一的名称和描述,以帮助识别连接。
- 在 属性下,输入连接的详细信息:
摘要信息 详细信息 客户ID 输入要用作连接器服务帐户集成的自定义 Box 应用的客户端 ID。 注: 在 Box 的 开发者控制台中,客户端 ID 会显示在自定义应用的 配置 选项卡下的 OAuth 2.0 凭据 中。
客户机密 输入自定义应用程序的客户端密钥。 注: 在 Box 的 开发者控制台 中,客户端密钥会显示在自定义应用的 配置 [ 选项卡下的 OAuth 2.0 凭据 中。
客户端密钥 输入为自定义应用程序创建的 private.pem文件的全部内容,包括标题行-----BEGIN RSA PRIVATE KEY-----、页脚行-----END RSA PRIVATE KEY-----以及任何尾随空格。企业 ID 输入自定义应用程序的企业 ID。 注: 在 Box 的 开发者控制台 中,企业 ID 会显示在自定义应用的 常规 [] 选项卡下的 [ 应用信息 中。
注意:所有敏感凭证均会自动加密,并以高级加密标准 (AES ) -256 加密方式存储
。 - 选择要使用连接的环境,然后单击 保存。
- 要测试连接, 创建并运行一个链 使用 连接器的 获取文件夹信息 命令,并验证它是否返回有效输出。
疑难解答
如果与 Box 的连接失败:
- 请确保自定义应用已在 Box 中获得授权。
- 验证自定义应用程序为连接器输入的客户端 ID 和密钥。在 Box 的 Dev Console 中,客户端 ID 和密钥显示在自定义应用程序的 Configuration 选项卡上的 OAuth 2.0 Credentials 下。要重置凭据,请单击 重置。
- 确保将
自定义应用程序的 public.pem和private.pem文件的 全部内容分别输入到应用程序和连接器的配置中。请包含页眉行、页脚行以及所有尾随空格。如有必要,请在 OpenSSL 中创建新的公钥/私钥对,并将其内容输入到应用程序和连接器的配置中。 - 请核实为连接器输入的自定义应用程序的企业 ID。在 Box 的 开发者控制台 中,企业 ID 会显示在自定义应用程序的 常规 [] 选项卡上的 应用信息 下。
- 确认共享文件夹已将服务帐户 ID 添加为协作者。