Frame.io V4模块

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

通过Adobe Workfront Fusion Frame.io模块,您可以在Frame.io帐户中监视、创建、更新、检索或删除资源和评论。

Workfront提供了两个Frame.io连接器,它们基于您所连接的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许可证

新增:标准

当前:工作或更高

Adobe Workfront Fusion许可证**

当前:无Workfront Fusion许可证要求

旧版:Workfront Fusion for Work Automation and Integration

产品

新:

  • 选择或Prime Workfront包:您的组织必须购买Adobe Workfront Fusion。
  • Ultimate Workfront包:其中包含Workfront Fusion。

当前:您的组织必须购买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 Beta模块中,单击“连接”框旁边的​ 添加
  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应用程序凭据页面上,输入以下内容:

    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 Beta模块中,单击“连接”框旁边的​ 添加

  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 Beta模块中,单击“连接”框旁边的​ 添加

  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字段,具体取决于应用程序或服务中的访问级别等因素。 模块中的粗体标题表示必填字段。

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

映射切换

资源

创建资产

此操作模块将创建新资源。

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

删除资产

此操作模块删除指定的资产。

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

获取资源

此操作模块可检索资产详细信息。

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

列出资源

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

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

观看资源已删除

此触发器模块会在删除资产后启动方案。

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

Webhook名称
输入新webhook的名称。
Connection
有关创建与Frame.io的连接的说明,请参阅本文中的将Frame.io连接到Adobe Workfront Fusion
帐户ID
选择帐户或映射您要监视已删除资产的帐户ID。

观看新资源

此触发器模块会在创建新资产后启动方案。

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

Webhook名称
输入新webhook的名称。
Connection
有关创建与Frame.io的连接的说明,请参阅本文中的将Frame.io连接到Adobe Workfront Fusion
帐户ID
选择帐户或映射要监视新资产的帐户的ID。

评论

创建评论

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

Connection
有关创建与Frame.io的连接的说明,请参阅本文中的将Frame.io连接到Adobe Workfront Fusion
帐户ID
选择帐户或映射包含要向其添加评论的资源的帐户的ID。
Workspace ID
选择帐户或映射包含要向其添加评论的资源的工作区的ID。
项目ID
选择项目或映射项目ID,该项目包含要添加注释的资产。
路径
选择要在其中添加评论的资源路径。
Text
输入评论或回复的文本内容。
Timestamp
在视频中输入评论应链接到的帧号。
如果资源是PDF,请输入或映射评论应附加到的页面。

删除评论

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

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

获取评论

此操作模块检索指定注释的详细信息。

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

列出评论

此搜索模块检索指定资源的所有注释。

Connection
有关创建与Frame.io的连接的说明,请参阅本文中的将Frame.io连接到Adobe Workfront Fusion
帐户ID
选择或映射包含要从中检索评论的资源的Account。
Workspace ID
选择或映射包含要从中检索注释的资源的工作区。
项目ID
选择包含要从中检索注释的资源的项目。
路径
选择指向要从中列出评论的资源的path。
返回的最大评论数
输入或映射您希望模块在每个方案执行周期中返回的最大注释数。

更新评论

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

Connection
有关创建与Frame.io的连接的说明,请参阅本文中的将Frame.io连接到Adobe Workfront Fusion
帐户ID
选择或映射包含项目的帐户,该项目包含要更新评论的资产。
注释ID
选择要更新的注释。
Text
输入注释的文本内容。
Timestamp
在评论链接到的视频中输入帧号。
如果资源是PDF,请输入或映射注释所附加到的页面。

观看评论已更新

此触发器模块会在注释更新后启动方案。

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

Webhook名称
输入新webhook的名称。
Connection
有关创建与Frame.io的连接的说明,请参阅本文中的将Frame.io连接到Adobe Workfront Fusion
帐户ID
选择帐户或映射要监视其更新注释的帐户的ID。

观看新评论

此触发器模块会在创建评论时启动方案。

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

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

文件夹

创建文件夹

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

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

项目

创建项目

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

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

邀请用户加入Frame.io项目

此操作模块邀请用户访问指定的Frame.io项目。

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

列出项目

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

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

共享

将资产添加到共享链接

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

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

创建共享链接

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

Connection
有关创建与Frame.io的连接的说明,请参阅本文中的将Frame.io连接到Adobe Workfront Fusion
帐户ID
选择或映射要在其中创建共享链接的帐户。
Workspace ID
选择或映射要在其中创建共享链接的工作区。
项目ID
选择或映射要在其中创建共享链接的项目。
访问
选择此链接是具有公共访问权限还是受限制访问权限。
资源
对于要添加到共享链接的每个资产,单击 添加项 并输入资产的ID。
描述
输入或映射共享链接的描述。
名称
输入或映射共享链接的到期日期。
名称
输入或映射新共享链接的名称。
名称
输入或映射共享链接的密码。

Workspace

创建 Workspace

此操作模块在Frame.io中创建新工作区

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

列出工作区

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

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

其他

进行自定义API调用

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

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

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

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

方法
选择配置API调用所需的HTTP请求方法。 有关详细信息,请参阅HTTP请求方法
Headers

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

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

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

查询字符串
输入请求查询字符串。 对于要包含在查询字符串中的每个参数,单击 添加项 并输入字段名称和所需值。
Body

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

注释:

在JSON中使用条件语句(如if)时,请将引号放在条件语句之外。

监视元数据值已更新

此触发器模块会在注释更新后启动方案。

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

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