Come usare i link di revisione

Panoramica

I link di revisione sono una funzionalità essenziale di Frame.io per raccogliere risorse e inviarle in modo da ricevere dei feedback tramite un singolo URL, senza richiedere accesso esplicito a team o progetti. In pratica, sono una rappresentazione delle risorse all’interno di un singolo progetto, quindi questa guida presuppone quanto segue:

  1. Hai già delle risorse a disposizione o sai come caricare le risorse tramite API.
  2. Conosci l’ID del progetto in cui desideri creare il link di revisione.
  3. Il tuo obiettivo è ottenere un URL da distribuire al di fuori di Frame.io (ad esempio tramite e-mail, chat o altri canali).

Concetti fondamentali

I link di revisione appartengono esclusivamente ai progetti e una risorsa in un link di revisione è rappresentata come tipo di risorsa speciale chiamato elemento del link di revisione, che conterrà sempre il review_link_id e l’asset_id a cui è abbinato, nonché l’intero payload della risorsa associata.

Sebbene gli elementi del link di revisione non debbano essere tracciati o gestiti autonomamente, rappresentano una struttura utile per comprendere l’intero flusso di lavoro descritto in questa guida. Di conseguenza, la gerarchia di un link di revisione ha questo aspetto:

Progetto > Link di revisione > Elemento del link di revisione > Riferimento risorsa

Ambiti richiesti

Prima di iniziare questa guida, assicurati di avere un token che includa almeno i seguenti ambiti:

AmbitoMotivo
Progetti: letturaNon strettamente necessario, ma serve per recuperare il root_asset_id di un progetto.
Risorse: letturaNon strettamente necessario, ma serve per navigare verso gli asset_id tramite API.
Link di revisione: creazione, lettura, aggiornamentoCrea il link di revisione, aggiungi risorse e recupera informazioni (soprattutto se il tracciamento avviene in un altro sistema).

1. Raccogli i tuoi ID

Per creare un link di revisione, devi raccogliere:

  1. Un ID progetto
  2. Gli ID di una o più risorse in quel progetto

Se non hai a portata di mano l’ID progetto, ma hai accesso a Frame.io e sai quale progetto vuoi utilizzare, puoi vedere l’ID nella barra degli indirizzi quando navighi al progetto: https://app.frame.io/projects/<project-id></project-id>. Allo stesso modo, se non hai a portata di mano gli ID delle risorse, vai alle risorse che ti interessano e richiama gli ID dalla barra degli indirizzi nel browser: https://app.frame.io/player/<asset-id></asset-id>.

Per creare la base per il link, devi determinare le opzioni che ti interessano per il link di revisione e generarle in un payload JSON. Come minimo, devi creare un nome (name). Ecco un esempio di payload che, per comodità, mostra le impostazioni predefinite per ogni campo se scegli di generare con un solo 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}

Ora effettua una chiamata POST autorizzata https://api.frame.io/v2/projects/:id/review_links, utilizzando il payload come corpo della richiesta.

Complimenti!Hai appena creato un link di revisione. Nel corpo della risposta ci sono due attributi importanti:

  • id: si tratta del riferimento al contenitore del link. Conservalo, perché ti servirà quando aggiungerai le risorse nel passaggio successivo.
  • short_url: si tratta dell’URL per il link di revisione che distribuirai. Avrà un aspetto simile a https://f.io/_aBcDeF

Ora che hai un link di revisione, è il momento di aggiungervi alcune risorse. Per iniziare, prepara un payload JSON con un array di stringhe degli id delle tue risorse:

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

Ora esegui una chiamata POST autorizzata a https://api.frame.io/v2/review_links/:id/assets, utilizzando l’id del link di revisione del passaggio 2 nel percorso e gli id delle tue risorse nel corpo della richiesta. Fatto! Ora puoi distribuire il tuo short_url.