Trabajar con vínculos de revisión

Información general

Los vínculos de revisión son una de las características principales de Frame.io para recopilar activos y enviarlos para obtener comentarios a través de una sola URL sin requerir acceso explícito al equipo o proyecto. Fundamentalmente, son una representación de activos dentro de un solo proyecto, por lo que en esta guía se asume que:

1. Tiene activos a mano o está familiarizado con el proceso de cargar activos a través de la API.
2. Conoce el ID del proyecto en el que le gustaría crear el vínculo de revisión.
3. Su objetivo es acabar con una URL que pueda distribuir fuera de Frame.io (por ejemplo, por correo electrónico, chat o cualquier otro medio).

Conceptos fundamentales

Los vínculos de revisión pertenecen estrictamente a los proyectos, y un activo en un vínculo de revisión se representa como un tipo de recurso especial llamado elemento de vínculo de revisión, que siempre contendrá el review_link_id y el asset_id que está uniendo, así como la carga útil completa del activo asociado.

Aunque los elementos de vínculo de revisión no necesitan rastrearse o administrarse por sí solos, son una estructura útil para entender el flujo de trabajo completo capturado en esta guía. Por lo tanto, la familia jerárquica de un vínculo de revisión tiene el siguiente aspecto:

Proyecto > Vínculo de revisión > Elemento de vínculo de revisión > Referencia de activo

Ámbitos necesarios

Antes de comenzar a leer esta guía, asegúrese de tener un token que incluya al menos los siguientes ámbitos:

1. Recopilar sus ID

Para crear un vínculo de revisión, necesitará recopilar:

1. Un ID de proyecto
2. Los ID de uno o varios activos de ese proyecto

Si no tiene a mano el ID del proyecto, pero tiene acceso a Frame.io y sabe qué proyecto quiere usar, puede ver el ID en la barra de direcciones al navegar al proyecto: https://app.frame.io/projects/<project-id></project-id>. Del mismo modo, si no tiene a mano los ID de los activos, vaya a los activos que quiera y extraiga los ID de la barra de direcciones de su explorador: https://app.frame.io/player/<asset-id></asset-id>.

2. Crear el vínculo de revisión

Para crear la base de su vínculo, deberá determinar las opciones de vínculo de revisión que desea y generarlas en una carga útil JSON. Como mínimo, deberá crear un name. A continuación, se muestra un ejemplo de carga útil: por comodidad, muestra los valores predeterminados de cada campo, en caso de que elija generar solo con un name:

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
}

Ahora realice una solicitud POST https://api.frame.io/v2/projects/:id/review_links autorizada con su carga útil como cuerpo de la solicitud.

Enhorabuena. Acaba de crear un vínculo de revisión. En el cuerpo de la respuesta, verá dos atributos importantes:

• id: Esta es la referencia a su contenedor de vínculo. Guárdela, ya que la necesitará cuando añada activos en el siguiente paso.
• short_url: Esta es la URL de su vínculo de revisión que distribuirá finalmente. Tendrá más o menos el siguiente aspecto: https://f.io/_aBcDeF

3. Añadir los activos al vínculo de revisión

Ahora que tiene un vínculo de revisión, es el momento de añadirle algunos activos. Empiece preparando una carga útil JSON con una matriz de cadena de los id de sus activos:

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

Ahora realice una solicitud POST autorizada a https://api.frame.io/v2/review_links/:id/assets, con el id del vínculo de revisión del paso 2 en su ruta y los id de sus activos en el cuerpo de la solicitud. Listo. Ya tiene todo lo necesario para distribuir su short_url.