Работа со ссылками для рецензирования

Обзор

Ссылки для рецензирования — это основная функция Frame.io для сбора ресурсов и их отправки для получения отзывов по одному URL-адресу без необходимости явного доступа к команде или проекту. В основном, они представляют собой ресурсы в рамках одного проекта, поэтому в этом руководстве предполагается следующее:

1. У вас есть ресурсы под рукой, или вы знакомы с добавлением ресурсов через API-интерфейс.
2. Вы знаете идентификатор проекта, в котором хотите создать ссылку для рецензирования.
3. Ваша цель — получить URL-адрес, который можно распространять за пределами Frame.io (например, по электронной почте, в чате или другими способами).

Основные концепции

Ссылки для рецензирования строго принадлежат проектам, а ресурс в ссылке для рецензирования представлен как специальный тип ресурса под названием элемент ссылки для рецензирования, который всегда будет содержать review_link_id и asset_id, которые он объединяет, а также полную полезную нагрузку связанного ресурса.

Хотя элементы ссылок для рецензирования не нужно отслеживать или управлять ими отдельно, они представляют собой полезную структуру для понимания полного рабочего процесса, описанного в этом руководстве. Соответственно, иерархическое семейство ссылки для рецензирования выглядит так:

Проект > Ссылка для рецензирования > Элемент ссылки для рецензирования > Ссылка на ресурс

Необходимые области доступа

Перед началом работы с этим руководством убедитесь, что у вас есть токен, который включает как минимум следующие области доступа:

1. Соберите свои идентификаторы

Для создания ссылки для рецензирования необходимо следующее:

1. Идентификатор проекта
2. Идентификаторы одного или нескольких ресурсов в этом проекте

Если у вас нет под рукой идентификатора проекта, но есть доступ к Frame.io и вы знаете, какой проект хотите использовать, идентификатор можно посмотреть в адресной строке при переходе к проекту: https://app.frame.io/projects/<project-id></project-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
}

Теперь выполните авторизованный запрос POST https://api.frame.io/v2/projects/:id/review_links, используя вашу полезную нагрузку в качестве тела запроса.

Поздравляем!Вы только что создали ссылку для рецензирования. В теле ответа вы увидите два важных атрибута:

• ИД: это ссылка на контейнер ссылки. Сохраните, поскольку она понадобится при добавлении ресурсов на следующем шаге.
• short_url: это URL-адрес вашей ссылки для рецензирования, которую вы будете распространять. Она будет выглядеть примерно так: https://f.io/_aBcDeF

3. Добавьте ресурсы в ссылку для рецензирования

Теперь, когда у вас есть ссылка для рецензирования, пора добавить к ней несколько ресурсов. Начните с подготовки полезной нагрузки JSON со строковым массивом идентификаторов ресурсов:

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

Теперь выполните авторизованный запрос POST к https://api.frame.io/v2/review_links/:id/assets, используя идентификатор ссылки для рецензирования из шага 2 в вашем пути и идентификаторы ваших ресурсов в теле запроса. Готово! Теперь вы готовы распространить short_url.