使用审阅链接

概述

审阅链接是 Frame.io 的一项核心功能,用于收集资产,并通过单个 URL 发送给他人以获取反馈,无需明确的团队或项目访问权限。从根本上讲,它们是单个项目内部资产的一种表现形式,因此本指南将假设:

  1. 您手头已有资产,或者熟悉通过 API 上传资产
  2. 您知道要在其中创建审阅链接的项目的 ID。
  3. 您的目标是最终得到一个可以在 Frame.io 外部(例如通过电子邮件、聊天或其他分发方式)分发的 URL。

核心概念

审阅链接严格归属于项目,审阅链接中的资产表示为一种名为审阅链接条目的特殊资源类型,该条目将始终包含它所关联的 review_link_idasset_id,以及关联资产的完整负载。

虽然审阅链接条目本身不需要单独跟踪或管理,但它们是一种有助于理解本指南所涵盖的完整工作流的结构。因此,审阅链接的层级关系如下所示:

项目 > 审阅链接 > 审阅链接条目 > 资产引用

必需的权限范围

在开始本指南之前,您需要确保拥有一个至少包含以下权限范围的令牌:

权限范围原因
**项目:**读取并非严格必须,但对于获取项目的 root_asset_id 是必需的。
**资产:**读取并非严格必须,但对于通过 API 导航到 asset_ids 是必需的。
**审阅链接:**创建、读取、更新创建审阅链接、添加资产,以及获取信息(特别是在另一个系统中进行跟踪时)。

1. 收集您的 ID

要创建审阅链接,您需要收集:

  1. 一个项目 ID
  2. 该项目中一个或多个资产的 ID

如果您手头没有项目 ID,但可以访问 Frame.io 并知道要使用哪个项目,您可以在导航到该项目时从地址栏中查看 ID:https://app.frame.io/projects/<project-id></project-id>. 同样,如果您手头没有资产 ID,请导航到所需的资产,然后从浏览器地址栏中提取 ID:https://app.frame.io/player/<asset-id></asset-id>.

2. 创建审阅链接

要构建链接的基础,您需要确定所需的审阅链接选项,并将其构建为 JSON 负载。至少,您需要提供一个名称。以下是一个示例负载——为方便起见,它显示了每个字段的默认值,如果您选择仅使用名称生成的话:

1{
2 "name": "New Review Link",
3 "allow_approvals": true,
4 "current_version_only": false,
5 "enable_downloading": true,
6 "expires_at": null,
7 "has_password": false
8}

现在,使用您的负载作为请求体,向 https://api.frame.io/v2/projects/:id/review_links 发起一个经过授权的 POST 请求。

祝贺您!您刚刚创建了一个审阅链接。在响应体中,您将看到两个重要属性:

  • id:这是对您链接容器的引用。请妥善保管,因为在下一步添加资产时您会用到它。
  • short_url:这是您最终要分发的审阅链接的 URL。它看起来类似于 https://f.io/_aBcDeF

3. 将资产添加到审阅链接

现在您已有了一个审阅链接,是时候向其中添加一些资产了。首先准备一个 JSON 负载,其中包含您资产 id 组成的字符串数组:

1{
2 "asset_ids":[
3 "<asset-id-1>",
4 "<asset-id-2>",
5 "<asset-id-3>"
6 ]
7}

现在,在您的路径中使用步骤 2 中的审阅链接 id,并将您的资产 id 放在请求体中,向 https://api.frame.io/v2/review_links/:id/assets 发起一个经过授权的 POST 请求。全部完成!您现在已准备就绪,可以分发您的 short_url 了。