Trabalhar com links de revisão

Visão geral

Os links de revisão são um recurso principal do Frame.io para coletar ativos e enviá-los para obter feedback por meio de um único URL, sem exigir acesso explícito à equipe ou ao projeto.Fundamentalmente, são uma representação de ativos de um único projeto, então este guia pressupõe que:

  1. Você tem ativos em mãos ou está familiarizado com o upload de ativos via API.
  2. Você conhece o ID do projeto no qual deseja criar o link de revisão.
  3. Sua meta é obter um URL que possa ser distribuído fora do Frame.io (por exemplo, via email, chat ou outro meio).

Conceitos principais

Os links de revisão pertencem estritamente aos projetos, e um ativo em um link de revisão é representado como um tipo de recurso especial chamado Item do link de revisão, que sempre conterá o review_link_id e o asset_id que está unindo, bem como o conteúdo completo do ativo associado.

Embora os itens do link de revisão não precisem ser rastreados ou gerenciados por conta própria, são uma estrutura útil para entender o fluxo de trabalho completo capturado neste guia.Consequentemente, a família hierárquica de um link de revisão é assim:

Projeto > Link de revisão > Item do link de revisão > Referência do ativo

Escopos obrigatórios

Antes de começar este guia, você precisará se certificar de que possui um token que inclua, no mínimo, os seguintes escopos:

EscopoMotivo
Projetos: LeituraNão é estritamente obrigatório, mas é necessário para obter o root_asset_id de um projeto.
Ativos: LeituraNão é estritamente obrigatório, mas necessário para navegar para asset_ids via API.
Links de revisão: Criação, leitura e atualizaçãoCriar o link de revisão, adicionar ativos e buscar informações (especialmente se estiver rastreando em outro sistema).

1. Reúna seus IDs

Para criar um link de revisão, você precisará reunir:

  1. Um ID do projeto
  2. Os IDs de um ou muitos ativos nesse projeto

Se você não tem o ID do projeto em mãos, mas tem acesso ao Frame.io e sabe qual projeto gostaria de usar, você pode ver o ID na barra de endereços ao navegar para o projeto: https://app.frame.io/projects/<project-id></project-id>. Da mesma forma, se você não tem os IDs do ativo em mãos, navegue para os ativos que deseja e obtenha os IDs da barra de endereços no navegador: https://app.frame.io/player/<asset-id></asset-id>.

Para fazer a base do seu link, você precisa determinar as opções desejadas do link de revisão e criá-las em um conteúdo JSON.No mínimo, você precisa criar um name.Aqui está um exemplo de conteúdo. Por conveniência, ele mostra os padrões para cada campo, caso você escolha gerar apenas com um 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}

Agora faça um POST autorizado https://api.frame.io/v2/projects/:id/review_links, usando seu conteúdo como o corpo da solicitação.

Parabéns!Você acabou de criar um link de revisão.No corpo da resposta, você verá dois atributos importantes:

  • id: esta é a referência para o contêiner do link.Guarde isso, pois você precisará na próxima etapa ao adicionar ativos.
  • short_url: este é o URL do seu link de revisão que você distribuirá.Será algo como https://f.io/_aBcDeF

Agora que você tem um link de revisão, é hora de adicionar alguns ativos a ele.Comece preparando um conteúdo JSON com uma string-array dos id(s) do seu ativo:

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

Agora faça um POST autorizado para https://api.frame.io/v2/review_links/:id/assets, usando o id do link de revisão da Etapa 2 no seu caminho e os ids do ativo no corpo da solicitação.Pronto!Agora você está pronto para distribuir seu short_url.