Authentification
Vue d’ensemble
L’authentification est requise pour effectuer des appels API avec l’API Frame.io. L’API Frame.io propose deux choix pour l’authentification :
- Jetons de développeur : un jeton porteur persistant qui porte les mêmes accès et autorisations que l’individu qui l’a généré.
- Flux de code d’autorisation OAuth 2, qui permettra aux utilisateurs Frame.io de se connecter avec leurs informations d’identification et d’accorder à une application externe l’autorisation d’agir en leur nom.
Toutes les actions utilisant l’API, qu’elles soient menées via l’un ou l’autre type d’authentification, utilisent finalement des en-têtes de jeton porteur et sont contrôlées par les portées.
Quel type d’authentification convient le mieux à mon projet ?
Pour la prise en main, vous voudrez utiliser un jeton de développeur pour votre projet. Les jetons de développeur sont associés au compte d’un individu, ont les mêmes autorisations d’accès que l’utilisateur qui les a créés et sont limités par les portées.
Ils sont parfaits pour :
- Expérimenter (car vous pouvez les créer et les détruire très rapidement)
- Les scénarios d’intégration où toutes les actions peuvent être effectuées via un seul contexte de compte/utilisateur.
Le flux de code OAuth convient aux applications hébergées en externe qui doivent agir au nom de plusieurs utilisateurs différents. Il y a un peu plus de gestion avec les jetons porteur via OAuth, il n’est donc pas rare d’expérimenter d’abord avec un jeton de développeur, puis de refactoriser le travail dans une application OAuth plus tard.
Pour continuer, vous aurez besoin d’un compte Frame.io. Si vous n’avez pas de compte Frame.io, vous pouvez vous inscrire rapidement et facilement en allant sur Frame.io et en cliquant sur Sign Up Free.
Jetons de développeur
- Connectez-vous au portail développeur Frame.io avec vos informations d’identification utilisateur Frame.io.
- Vous devriez obtenir l’écran de bienvenue. Pour créer un nouveau jeton de développeur, cliquez sur le bouton Create a Token.
- Vous obtiendrez l’écran Jetons. Cliquez sur New.
- Sur l’écran du nouveau jeton, vous devez fournir une description et des portées pour votre jeton. Pour DESCRIPTION, nous recommandons de choisir quelque chose qui vous aidera à vous rappeler de l’utilisation du jeton. Dans SCOPES, vous pouvez sélectionner les portées d’accès précises dont ce jeton doit disposer. Pour cette procédure pas à pas, cliquez simplement sur Sélectionner toutes les portées. Vous pouvez créer des jetons avec des autorisations et privilèges plus spécifiques plus tard selon vos besoins (voir Portées pour plus d’informations).
- Faites défiler vers le bas et cliquez sur le bouton Créer. Si vous réussissez, vous obtiendrez une page avec un résumé des informations concernant votre jeton.
- Copiez la chaîne présentée dans le champ Jeton. Il s’agit de votre nouveau jeton. Conservez-le dans un endroit sûr — il représente l’accès à votre compte, et une fois que vous quittez cette page, vous ne pourrez plus le voir.
À ce stade, vous devriez recevoir un e-mail confirmant que vous avez créé un jeton avec les portées choisies.
Les jetons Frame.io sont affichés uniquement lors de la création initiale. Si vous perdez un jeton, vous pouvez toujours en créer un nouveau ; mais vous ne pourrez jamais revoir les anciens jetons, à l’exception de leurs descriptions et portées.
Test de votre nouveau jeton
Maintenant que vous avez votre jeton, essayons une requête utilisant l’authentification bearer. Nous ferons une requête de base pour obtenir des informations vous concernant :
En réponse, vous devriez voir une représentation JSON de votre enregistrement Utilisateur.
Félicitations ! Vous venez de faire votre premier appel à l’API Frame.io. 🎉
Qu’est-ce qu’OAuth 2 ?
OAuth2.0 est un protocole d’authentification courant qui permet à un utilisateur d’autoriser une application à interagir avec une autre de façon limitée, sans partager directement les informations d’identification. Ce processus est normalement appelé « octroi d’informations d’identification » par un utilisateur, via un écran de connexion spécial.
Flux de code d’autorisation OAuth 2
Le flux de code d’autorisation OAuth 2 permet aux utilisateurs d’octroyer un accès limité aux applications externes. Une application demande des autorisations spécifiques en fonction de sa configuration initiale — dans le cas de Frame.io, lorsque l’application est enregistrée sur notre portail développeur. L’utilisateur approuve la demande, et l’application externe peut alors agir au nom de cet utilisateur. Découvrez comment commencer avec le flux de code d’autorisation OAuth 2 ici : Configurer le flux de code d’authentification OAuth 2
En savoir plus sur OAuth 2
Si vous voulez en savoir plus sur OAuth 2, voici d’excellentes ressources :