Introduction

Démarrage rapide

Ce guide vous indique la manière la plus rapide de réussir votre premier appel à l’API Frame.io V4. Vous allez créer un projet dans l’Adobe Developer Console, générer des informations d’identification et effectuer votre première requête API.

Étape 1 : créer un projet dans votre Adobe Developer Console + ajouter l’API Frame.io V4

Dans l’Adobe Developer Console, créez un nouveau projet et ajoutez l’API Frame.io V4.

Ce guide utilise l’appli web OAuth 2.0 pour l’authentification. Pour plus d’informations sur d’autres méthodes d’authentification, consultez le Guide d’authentification

Étape 2 : configurer votre application

Sélectionnez l’appli web OAuth comme type d’application et définissez vos champs de redirection.

URI de redirectionUn chemin dans votre application qui reçoit la réponse d’OAuth d’Adobe IMS. Une fois qu’un utilisateur s’est connecté et a approuvé l’accès, Adobe IMS le redirige vers cette URL avec un code d’autorisation dans la chaîne de requête, que votre appli échange ensuite contre un jeton d’accès
Motif d’URI de redirectionMotifs correspondant à des URL de redirection supplémentaires au-delà de l’URI de redirection par défaut. Ceci est utile si votre appli s’exécute dans plusieurs environnements ou utilise un routage dynamique. Plusieurs motifs doivent être fournis sous la forme d’une liste séparée par des virgules

Étape 3 : s’authentifier

Lancez le flux OAuth en redirigeant l’utilisateur vers le point d’entrée d’autorisation Adobe IMS :

  https://ims-na1.adobelogin.com/ims/authorize/v2
  ?client_id={CLIENT_ID}
  &redirect_uri={REDIRECT_URI}
  &scope=offline_access,openid,email,profile,additional_info.roles
  &response_type=code

Une fois que l’utilisateur s’est connecté et a approuvé l’accès, Adobe IMS le redirige vers l’URI de redirection que vous avez configuré, en incluant un code d’autorisation dans la chaîne de requête. Échangez ce code contre un jeton d’accès en envoyant une requête POST au point d’entrée du jeton de l’IMS.


Voici une liste des définitions des paramètres, accompagnée d’un exemple de requête et de réponse :

ParamètreObligatoireDescription
codeOuiValeur de la chaîne de requête du code renvoyée à votre redirect_uri lorsqu’un utilisateur s’authentifie auprès de votre application.
grant_typeOuiLa valeur doit toujours être authorization_code.
authorizationObligatoire pour les clients confidentiels
Exemple de requête
curl -X POST 'https://ims-na1.adobelogin.com/ims/token/v3' \
  -H 'Authorization: Basic {AUTHORIZATION}' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'code={CODE}&grant_type=authorization_code'

Exemple de réponse

{
    "access_token": "{ACCESS_TOKEN}",
    "refresh_token": "{REFRESH_TOKEN}",
    "sub": "B0DC108C5CD449CA0A494133@c62f24cc5b5b7e0e0a494004",
    "id_token": "{ID_TOKEN}",
    "token_type": "bearer",
    "expires_in": 86399
}
Assistance SDK

Les SDK Python et TypeScript comprennent tous deux des modules d’authentification qui gèrent la procédure d’authentification OAuth, l’échange de jetons et le renouvellement automatique des jetons. Vous trouverez plus d’informations sur chacun d’entre eux ici :

Python | TypeScript

Étape 4 : effectuer vos premières requêtes API

Une fois que vous disposez de votre jeton d’accès, commencez par appeler le point d’entrée /v4/me :

curl https://api.frame.io/v4/me \
-H "Authorization: Bearer <token>"

Cette requête appelle l’API Adobe IMS pour vérifier votre jeton et vos informations d’utilisateur.

Une requête réussie renvoie des informations sur l’utilisateur authentifié, notamment son identifiant user_id, son nom et son adresse e-mail. Utilisez cette fonction pour vérifier que votre flux d’authentification fonctionne comme prévu.

La plupart des points d’entrée de l’API V4 nécessitent un account_id, qui n’est pas renvoyé par /v4/me. Pour obtenir votre account_id, envoyez une requête à /v4/accounts :

curl https://api.frame.io/v4/accounts \
-H "Authorization: Bearer <token>"

Cette méthode renvoie la liste des comptes accessibles à l’utilisateur authentifié. Utilisez l’identifiant account_id fourni dans cette réponse pour vos prochaines requêtes API.

Identifiant utilisateur vs identifiant de compte

Votre user_id vous identifie en tant que personne physique, et votre account_id représente l’organisation à laquelle vous appartenez. La plupart des points d’entrée V4 fonctionnent au niveau du compte.

Étapes suivantes

Une fois l’authentification effectuée et votre identifiant de compte account_id en votre possession, vous êtes prêt à commencer à utiliser l’API Frame.io. Voici quelques ressources qui peuvent vous aider à vous lancer :