Frame.io V4 模块

IMPORTANT
本文介绍新版 Frame.io 连接器。此连接器用于连接到 Frame.io 版本 4。
有关旧版 Frame.io 连接器的使用说明,请参阅 Frame.io 旧版连接器

Adobe Workfront Fusion 的 Frame.io 模块可用于在您的 Frame.io 帐户中监控、创建、更新、检索或删除资源和评论。

根据您要连接的 Frame.io 版本,Workfront 提供两个不同的 Frame.io 连接器。

连接器
Frame.io 版本
Frame.io
V4
Frame.io(旧版)
V3

有关旧版 Frame.io 连接器的使用说明,请参阅 Frame.io 旧版连接器

有关 Frame.io 连接器的视频介绍,请参阅:

访问权限要求

展开可查看本文所述功能的访问权限要求。
table 0-row-2 1-row-2 2-row-2 3-row-2 layout-auto html-authored no-header
Adobe Workfront 包

任意 Adobe Workfront Workflow 包以及任意 Adobe Workfront 自动化和集成包

Workfront Ultimate

Workfront Prime 和 Select 包,且需额外购买 Workfront Fusion。

Adobe Workfront 许可证

标准

工作版或更高版本

Adobe Workfront Fusion 许可证

基于操作:不需要 Workfront Fusion 许可证

基于连接器(旧版):用于工作自动化和集成的 Workfront Fusion

产品 如果您的组织使用的 Workfront Select 或 Prime 包不包含 Workfront 自动化和集成,则必须单独购买 Adobe Workfront Fusion。

有关此表中信息的更多详细说明,请参阅文档中的访问权限要求

有关 Adobe Workfront Fusion 许可证的详细信息,请参阅 Adobe Workfront Fusion 许可证

先决条件

要使用 Frame.io 模块,您必须拥有一个 Frame.io 帐户

Frame.io API 信息

Frame.io 连接器使用以下内容:

基础 URL
https://api.frame.io/v4
API 版本
v2
API 标记
v1.0.76

将 Frame.io 连接到 Adobe Workfront Fusion

您可以通过用户凭据自动连接、手动创建用户凭据连接,或创建服务器到服务器的连接。

使用用户凭据自动连接

如果您已登录 Frame.io,此方法将自动创建连接;如果未登录,则会跳转至 Frame.io 登录页面以便您登录。

  1. 在任意 Frame.io 模块中,点击“连接”框旁边的​添加
  2. 输入连接名称。
  3. 单击​继续
  4. 如果系统提示您登录 Frame.io 帐户,请完成登录。
  5. 如果您属于多个 Frame.io 组织,请选择要用于此次连接的组织。

连接已创建。

手动创建用户凭据连接

您可以通过登录 Frame.io,或提供客户端 ID 与客户端密钥来创建用户凭据连接。

若要创建服务器到服务器连接,必须先在 Adobe Developer Console 中配置一个应用程序。

在 Adobe Developer Console 中创建用户凭据

如果您的 Adobe Developer Console 项目中尚未包含服务器到服务器凭据,您可以创建新的凭据。

  1. 打开 Adobe Developer Console

  2. 选择 Adobe Developer Console 中的现有项目以用于此连接。

    在 Adobe Developer Console 中创建新项目。有关操作步骤,请参阅创建空白项目

  3. 在“项目”概述页面或“开始使用”新项目页面,点击​添加 API

  4. 在打开的页面中找到并点击 Frame.io API

  5. 在“选择”身份验证类型页面,选择​用户身份验证,然后点击​下一步

  6. 在“添加用户身份验证凭据”页面,选择 OAuth Web App,然后点击​下一步

  7. 在“配置 OAuth Web App 凭据”页面,输入以下信息:

    table 0-row-2 1-row-2 layout-auto html-authored no-header
    默认重定向 URI https://oauth.app.workfrontfusion.com/oauth/cb/frame-io2
    重定向 URI 模式 https://oauth\.app\.workfrontfusion\.com/oauth/cb/frame-io2
  8. 单击​下一步

  9. 单击​保存配置的 API

  10. 在产品页面,点击刚创建的凭据卡片。

    您可以在此处找到您的客户端 ID 和客户端密钥。

NOTE
建议在开始在 Adobe Workfront Fusion 中配置连接时保持此窗口打开。您可以从此页面复制客户端 ID,并获取并复制客户端密钥,然后粘贴到连接字段中。

配置用户身份验证连接

  1. 在任意 Frame.io 模块中,点击“连接”框旁边的​添加

  2. 在“创建连接”框中,单击​显示高级设置

  3. 填写以下字段:

    table 0-row-2 1-row-2 2-row-2 3-row-2 layout-auto html-authored no-header
    连接类型 选择 IMS 用户身份验证
    连接名称 输入此连接的名称。
    客户端 ID

    输入您的 Adobe 客户端 ID。该值可在 Adobe Developer Console 的凭据详细信息部分找到。

    有关创建凭据的说明,请参阅本文中的在 Adobe Developer Console 中创建用户凭据

    客户端密钥

    输入您的 Adobe 客户端密钥。该值可在 Adobe Developer Console 的凭据详细信息部分找到。

    有关创建凭据的说明,请参阅本文中的在 Adobe Developer Console 中创建用户凭据

  4. 如果系统提示您登录 Frame.io 帐户,请完成登录。

  5. 如果您属于多个 Frame.io 组织,请选择要用于此次连接的组织。

连接已创建。

创建服务器到服务器连接

若要创建服务器到服务器连接,必须先在 Adobe Developer Console 中配置一个应用程序。

在 Adobe Developer Console 中创建服务器到服务器凭据

如果您的 Adobe Developer Console 项目中尚未包含服务器到服务器凭据,您可以创建新的凭据。

  1. 打开 Adobe Developer Console

  2. 选择 Adobe Developer Console 中的现有项目以用于此连接。

    在 Adobe Developer Console 中创建新项目。有关操作步骤,请参阅创建空白项目

  3. 在“项目”概述页面或“开始使用”新项目页面,点击​添加 API

  4. 在打开的页面中找到并点击 Frame.io API

  5. 在“选择身份验证类型”页面,选择​服务器到服务器身份验证,然后点击​下一步

  6. 输入此凭据的名称。此名称将用于在 Adobe Admin Console 的 API 凭据区域中识别该凭据。

  7. 点击​下一步

  8. 在“选择产品轮廓”页面,选择包含您要连接的 Frame.io 帐户的产品轮廓。

  9. 单击​保存配置的 API

  10. 在产品页面,点击刚创建的凭据卡片。

    您可以在此处找到您的客户端 ID 和客户端密钥。

NOTE
建议在开始在 Adobe Workfront Fusion 中配置连接时保持此窗口打开。您可以从此页面复制客户端 ID,并获取并复制客户端密钥,然后粘贴到连接字段中。

配置服务器到服务器连接

  1. 在任意 Frame.io 模块中,点击“连接”框旁边的​添加

  2. 填写以下字段:

    table 0-row-2 1-row-2 2-row-2 3-row-2 layout-auto html-authored no-header
    连接类型 选择 IMS 服务器到服务器
    连接名称 输入此连接的名称。
    客户端 ID

    输入您的 Adobe 客户端 ID。该值可在 Adobe Developer Console 的凭据详细信息部分找到。

    有关创建凭据的说明,请参阅本文中的在 Adobe Developer Console 中创建服务器到服务器凭据

    客户端密钥

    输入您的 Adobe 客户端密钥。该值可在 Adobe Developer Console 的凭据详细信息部分找到。

    有关创建凭据的说明,请参阅本文中的在 Adobe Developer Console 中创建服务器到服务器凭据

  3. 点击​ 继续 ​保存连接并返回模块。

Frame.io 模块及其字段

在您配置 Frame.io 模块时,Workfront Fusion 会显示以下字段。除这些字段外,根据您的应用程序或服务访问权限级别,可能会显示更多 Frame.io 字段。模块中的加粗标题表示必填字段。

如果您看到字段或功能上方的映射按钮,可使用它为该字段设置变量和函数。有关详细信息,请参阅将信息从一个模块映射到另一个模块

映射切换

资源

创建资源

此操作模块将创建新资源。 您可以上传本地文件,也可以提供从中创建资产的远程文件的URL。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择包含要创建资源的项目的帐户,或映射该帐户 ID。
工作区 ID
选择包含要创建资源的项目的工作区,或映射该工作区 ID。
项目 ID
选择您要在其中创建资源的项目,或映射该项目 ID。
路径
选择要创建资源的路径。
上传类型
选择是从本地文件还是从远程生命周期创建资产。
文件大小
如果要上载本地文件,请输入或映射文件大小(以字节为单位)。
源 URL
如果从远程文件创建资产,请输入要上传的文件的URL。
Source file
从上一个模块中选择源文件,或映射源文件的名称。

创建资产(旧版)

此操作模块用于创建新资源。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择包含要创建资源的项目的帐户,或映射该帐户 ID。
工作区 ID
选择包含要创建资源的项目的工作区,或映射该工作区 ID。
项目 ID
选择您要在其中创建资源的项目,或映射该项目 ID。
路径
选择要创建资源的路径。
文件名
输入要用于此资源的文件的名称。
文件大小
输入或映射文件大小(以字节为单位)。
源 URL
如果要创建文件,请输入您要上传的文件 URL。
媒体类型
选择此资源的媒体类型。

删除资源

此操作模块用于删除指定资源。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择包含要删除资源的帐户,或映射该帐户 ID。
资源 ID
选择或映射您要删除的资源。

获取资源

此操作模块用于检索资源详细信息。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择包含要检索的资源的帐户,或映射该帐户 ID。
资源 ID
选择或映射您要检索的资源。

列出资源

此搜索模块会检索指定项目文件夹中的所有资源。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择包含要列出的资源的帐户,或映射该帐户 ID。
返回资源的最大数量
输入或映射该模块在每次场景执行周期内应返回的资源最大数量。

查看已删除的资源

当删除资源时,此触发器模块会启动一个场景。

选择要用于此模块的 webhook,或点击 Webhook 字段旁的“添加”并输入以下信息:

Webhook 名称
输入新 webhook 的名称。
连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射您希望查看其资源删除事件的帐户 ID。

查看新资源

当创建新资源时,此触发器模块会启动一个场景。

选择要用于此模块的 webhook,或点击 Webhook 字段旁的“添加”并输入以下信息:

Webhook 名称
输入新 webhook 的名称。
连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射您希望查看其新资源创建事件的帐户 ID。

评论

创建评论

此操作模块会向资源添加新的评论或回复。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择包含要添加评论的资源的帐户,或映射该帐户 ID。
工作区 ID
选择包含要添加评论的资源的帐户,或映射该工作区的 ID。
项目 ID
选择包含要添加评论的资源的项目,或映射该项目的 ID。
路径
选择您想要添加评论的资源路径。
文本
输入评论或回复的文本内容。
时间戳
输入该评论在视频中所对应的帧编号。
页面
如果资源为 PDF,请输入或映射评论应附加到的页面编号。

删除评论

此操作模块用于删除现有评论。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择包含要删除评论的帐户,或映射该帐户 ID。
评论 ID
输入或映射您要删除的评论 ID。

获取评论

此操作模块用于检索指定评论的详细信息。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择包含您要检索评论详细信息的评论所在帐户,或映射该帐户 ID。
评论 ID
选择您要检索详细信息的评论。

列出评论

此搜索模块会检索指定资源的所有评论。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射包含您想要检索评论的资源的帐户。
工作区 ID
选择或映射包含您想要检索评论的资源的工作区。
项目 ID
选择包含您想要检索评论的资源的项目。
路径
选择指向要列出评论的资源的路径。
返回评论的最大数量
输入或映射该模块在每次场景执行周期内应返回的评论最大数量。

更新评论

此操作模块用于编辑现有评论。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射包含该项目的帐户,该项目中包含要更新评论的资源。
评论 ID
选择要更新的评论。
文本
输入评论的文本内容。
时间戳
输入该评论在视频中对应的帧编号。
页面
如果资源为 PDF,请输入或映射评论所在的页面编号。

查看更新的评论

当更新评论时,此触发器模块会启动一个场景。

选择要用于此模块的 webhook,或点击 Webhook 字段旁的“添加”并输入以下信息:

Webhook 名称
输入新 webhook 的名称。
连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择您想要查看更新评论的帐户,或映射该帐户的 ID。

查看新评论

当创建评论时,此触发器模块会启动一个场景。

选择要用于此模块的 webhook,或点击 Webhook 字段旁的“添加”并输入以下信息:

Webhook 名称
输入新 webhook 的名称。
连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射您希望查看其新评论的帐户 ID。

文件夹

创建文件夹

此操作模块会在 Frame.io 中创建一个新文件夹。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射您希望创建文件夹的帐户。
工作区 ID
选择或映射您希望创建文件夹的工作区。
项目 ID
选择您希望创建文件夹的项目。
路径
选择您希望创建文件夹的路径。
名称
输入或映射新文件夹的名称。

项目

创建项目

此操作模块会在 Frame.io 中创建一个新项目。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射您希望创建项目的帐户。
工作区 ID
选择或映射您希望创建项目的工作区。
名称
输入或映射新项目的名称。

邀请用户加入 Frame.io 项目

此操作模块会将用户邀请至指定的 Frame.io 项目。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射包含要邀请用户加入的项目的帐户。
工作区 ID
选择或映射包含要邀请用户访问的项目的工作区。
项目 ID
选择或映射您希望邀请用户加入的项目。
用户 ID
选择或映射您希望邀请加入该项目的用户。

列出项目 ​

此搜索模块会检索指定团队的所有项目。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射包含您想要检索项目的资源的帐户。
工作区 ID
选择或映射包含您想要检索项目的资源的工作区。
返回项目的最大数量
输入或映射模块在每次场景执行周期中应返回的项目最大数量。

共享

将资源添加到共享链接

此操作模块会将资源添加到 Frame.io 中的共享链接。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射包含您想要向其添加资源的共享链接的帐户。
共享链接 ID
选择或映射您希望添加资源的共享链接。
资源 ID
输入或映射您要添加至共享链接的资源 ID。

创建共享链接

此操作模块会在 Frame.io 中创建一个新的共享链接。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射您希望创建共享链接的帐户。
工作区 ID
选择或映射您希望创建共享链接的工作区。
项目 ID
选择或映射您希望创建共享链接的项目。
访问
选择共享链接的访问权限为公开或受限。
资源
对于每一个要添加到共享链接的资源,点击 添加项目 并输入该资源的 ID。
描述
输入或映射共享链接的描述。
名称
输入或映射共享链接的到期日期。
名称
输入或映射新共享链接的名称。
名称
输入或映射共享链接的密码短语。

工作区

创建工作区

此操作模块会在 Frame.io 中创建一个新工作区。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射您希望创建工作区的帐户。
名称
输入或映射工作区的新名称。

列出工作区

此模块会列出帐户中的所有工作区。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射包含您想要检索工作区的资源的帐户。
返回工作区的最大数量
输入或映射模块在每次场景执行周期中应返回的工作区最大数量。

元数据

创建帐户级别字段

此操作模块会创建并配置新的帐户级别元数据字段。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射要在其中创建元数据的帐户。
字段类型
选择要创建的元数据字段类型,然后配置该字段的选项。
名称
输入或映射新字段的名称。

删除帐户级别字段

此操作模块会删除单个帐户级别的元数据字段。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射包含要删除的元数据字段的帐户。
字段定义Id
输入或映射要删除的字段的ID。 您可以使用列表帐户级别字段模块查找字段ID。

获取元数据

此操作模块检索Frame.io中文件的元数据。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射包含要检索元数据的文件的帐户。
文件Id
输入或映射要为其检索元数据的文件的ID。
显示null
启用此选项以在输出中包含值为null的字段。

列出帐户级别字段

此模块检索指定帐户的帐户级别元数据字段列表。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射要从中列出字段的帐户。
返回的最大协议数
输入或映射您希望模块在每个方案执行周期中返回的最大字段数。

更新帐户级别字段定义

此模块更新单个现有元数据字段的定义。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射要在其中创建元数据的帐户。
字段定义Id
输入或映射要更新的字段的ID。 您可以使用列表帐户级别字段模块查找字段ID。
字段类型
如果要更改字段的字段类型,请选择要创建的元数据字段类型,然后配置该字段的选项。
名称
输入或映射字段的新名称。

跨多个文件更新元数据

此模块使用您指定的值更新一个或多个文件上的元数据字段。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择或映射包含要为其更新元数据的文件的帐户。
工作区 ID
选择包含要创建资源的项目的工作区,或映射该工作区 ID。
项目 ID
选择您要在其中创建资源的项目,或映射该项目 ID。
文件ID
对于每个要更新元数据的文件,单击 添加项 并输入或映射文件的ID。
Values
对于要更新元数据的每个字段,单击添加项,然后输入或映射字段定义的ID以及要放入该字段中的值。 在“文件ID”字段中指定的所有文件都将使用此字段值更新。

其他

发起自定义 API 调用

此模块允许您执行自定义 API 调用。

连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
URL

输入相对于 https://api.frame.io 的路径。示例: /v4/me

注意:有关可用端点列表,请参阅 Frame.io API 参考文档。

方法
选择用于配置此 API 调用的 HTTP 请求方法。有关更多信息,请参阅 HTTP 请求方法
标头

以标准 JSON 对象的形式添加请求标头。

例如, {"Content-type":"application/json"}

Workfront Fusion 会自动添加授权标头。

查询字符串
输入请求的查询字符串。对于向查询字符串中添加的每一个参数,点击 添加项目 并输入字段名称和对应的值。
正文

以标准 JSON 对象的形式添加 API 调用的正文内容。

注释:

在 JSON 中使用 if 等条件语句时,需将引号置于条件语句外部。

查看更新的元数据值

当更新评论时,此触发器模块会启动一个场景。

选择要用于此模块的 webhook,或点击 Webhook 字段旁的“添加”并输入以下信息:

Webhook 名称
输入新 webhook 的名称。
连接
有关创建与 Frame.io 的连接的说明,请参阅本文中的将 Frame.io 连接到 Adobe Workfront Fusion
帐户 ID
选择您想要查看元数据值更新的帐户,或映射该帐户的 ID。
recommendation-more-help
7e1891ad-4d59-4355-88ab-a2e62ed7d1a3