Utilisation des liens de révision

Aperçu

Les liens de révision constituent une fonctionnalité essentielle de Frame.io pour collecter des ressources et les diffuser pour obtenir des commentaires via une URL unique sans nécessiter d’accès explicite à une équipe ou un projet. Fondamentalement, ils représentent des ressources au sein d’un projet unique. Ce guide part donc du principe que :

1. Vous disposez de ressources ou vous connaissez le chargement de ressources via API.
2. Vous connaissez l’ID du projet dans lequel vous souhaitez créer le lien de révision.
3. Votre objectif est d’obtenir une URL que vous pouvez diffuser en dehors de Frame.io (par exemple, par e-mail, messagerie ou autre moyen de diffusion).

Concepts de base

Les liens de révision appartiennent strictement aux projets, et une ressource dans un lien de révision est représentée comme un type de ressource spécial appelé élément de lien de révision, qui contiendra toujours le review_link_id et l’asset_id qu’il joint, ainsi que la charge complète de la ressource associée.

Bien que les éléments de lien de révision n’aient pas besoin d’être suivis ou gérés individuellement, ils constituent une structure utile pour comprendre le processus complet présenté dans ce guide. Par conséquent, la hiérarchie familiale d’un lien de révision est la suivante :

Projet > Lien de révision > Élément de lien de révision > Référence de ressource

Portées requises

Avant de commencer ce guide, vous devez vous assurer de disposer d’un jeton qui inclut au moins les portées suivantes :

1. Rassemblez vos ID

Pour créer un lien de révision, vous devez rassembler :

1. Un ID de projet
2. Les ID d’un ou plusieurs asset du projet

Si vous n’avez pas l’ID de projet à portée de main, mais que vous avez accès à Frame.io et savez quel projet vous souhaitez utiliser, vous pouvez voir l’ID dans votre barre d’adresse lorsque vous naviguez vers le projet : https://app.frame.io/projects/<project-id></project-id>. De même, si vous n’avez pas les ID d’asset à portée de main, naviguez vers les asset souhaités et récupérez les ID dans la barre d’adresse de votre navigateur : https://app.frame.io/player/<asset-id></asset-id>.

2. Créer le lien de révision

Pour créer la base de votre lien, vous devez déterminer vos OPTIONS de lien de révision souhaitées et les intégrer dans une charge utile JSON. Au minimum, vous devez définir un nom. Voici un exemple de charge utile — par commodité, elle affiche les valeurs par défaut de chaque champ, si vous choisissez de générer avec un nom uniquement :

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
}

Effectuez maintenant un POST autorisé https://api.frame.io/v2/projects/:id/review_links, en utilisant votre charge utile comme corps de requête.

Félicitations ! Vous venez de créer un lien de révision. Dans le corps de la réponse, vous verrez deux attributs importants :

• id : Il s’agit de la référence de votre conteneur de lien. Conservez-la, car vous en aurez besoin lorsque vous ajouterez des asset à l’étape suivante.
• short_url : Il s’agit de l’URL de votre lien de révision que vous distribuerez. Elle ressemblera à https://f.io/_aBcDeF

3. Ajouter les asset au lien de révision

Maintenant que vous avez un lien de révision, il est temps d’y ajouter des asset. Commencez par préparer une charge utile JSON avec un tableau de chaînes de vos id d’asset :

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

Effectuez maintenant un POST autorisé vers https://api.frame.io/v2/review_links/:id/assets, en utilisant l’id du lien de révision de l’étape 2 dans votre chemin d’accès, et vos id d’asset dans le corps de la requête. Terminé ! Vous êtes maintenant prêt à distribuer votre short_url.