Crear una aplicación de OAuth 2 | Frame.io API Documentation

En esta guía se asume que ya ha registrado una aplicación de OAuth 2.

Si no es así, consulte Flujo de código de OAuth 2 para configurar su aplicación.

Conceptos básicos de la aplicación

Nota: Debe almacenar su client_id y (si no usa PKCE) client_secret de forma segura y acceder a ellos a través de su entorno. En los siguientes ejemplos se asume la presencia de un archivo .env que contiene las variables CLIENT_ID y CLIENT_SECRET.

Python

1 import urllib, requests, requests.auth
2 import os
3 
4 CLIENT_ID = os.environ.get('CLIENT_ID')
5 CLIENT_SECRET = os.environ.get('CLIENT_SECRET')
6 
7 AUTHORIZE_URL = "https://applications.frame.io/oauth2/auth"
8 TOKEN_URL = "https://applications.frame.io/oauth2/token"
9 # The scopes you've chosen for your app, space-delimited
10 SCOPE = "offline account.read asset.read" 
11 # The callback URI for your app
12 REDIRECT_URI = "https://yourapp.domain/callback"

Invocar el servidor de autorización

Primero, su aplicación necesitará llamar al servidor de autorización de Frame.io, que luego redirigirá al usuario a una página de inicio de sesión.

Python

1 import uuid
2 from urllib.parse import urlencode
3 
4 def create_auth_url():
5  credentials = {
6   'response_type': 'code',
7   'redirect_uri': REDIRECT_URI,
8   'client_id': CLIENT_ID,
9   'scope': SCOPE,
10   'state': str(uuid.uuid4())
11  }
12  url = (AUTHORIZE_URL + "?" + urlencode(credentials))
13  return url

Devolución de llamada

El servidor de autorización entonces realizará una solicitud GET a su REDIRECT_URI, que a su vez necesitará llamar al TOKEN_URL. Esta devolución de llamada será ligeramente diferente dependiendo de si su aplicación está configurada para usar PKCE o no.

Sin PKCE

Si no está usando PKCE, su devolución de llamada debe incluir un encabezado Authorization que incluya su CLIENT_ID y CLIENT_SECRET.

Python

1 def callback():
2    state = request.args.get('state')
3    scope = request.args.get('scope')
4    code = request.args.get('code')
5    error = request.args.get('error')
6 
7    if error:
8      return "Error: " + error
9 
10    # Set up for client authorization and set up the data you need to send.
11    client_auth = requests.auth.HTTPBasicAuth(CLIENT_ID, CLIENT_SECRET)
12 
13    post_data = {
14      "grant_type": "authorization_code",
15      "code": code,
16      "redirect_uri": REDIRECT_URI,
17      "state": state,
18      "scope": SCOPE
19    }
20 
21 # Send a POST request with the data you need to receive an access token. 
22 # If everything goes well, it will be returned to you and you can use it with
23 # Frame.io.
24 
25    response = requests.post(TOKEN_URL, auth=client_auth, data=post_data)    
26    return response.text

Con PKCE

Si está usando PKCE, su devolución de llamada no debe incluir un encabezado Authorization, pero debe incluir su CLIENT_ID en el cuerpo de su solicitud POST al devolver la llamada al TOKEN_URL.

Python

1 def callback():
2    state = request.args.get('state')
3    scope = request.args.get('scope')
4    code = request.args.get('code')
5    error = request.args.get('error')
6 
7    if error:
8      return "Error: " + error
9 
10 # If using PKCE, you must include the CLIENT_ID in your request body  
11    post_data = {
12      "grant_type": "authorization_code",
13      "code": code,
14      "redirect_uri": REDIRECT_URI,
15      "state": state,
16      "scope": SCOPE
17      "client_id": CLIENT_ID 
18    }
19 
20 # Send a POST request with the data you need to receive an access token. 
21 # If everything goes well, it will be returned to you and you can use it with
22 # Frame.io
23 
24   # If using PKCE, use the below request with no auth
25   response = requests.post(TOKEN_URL, data=post_data) 
26 
27    return response.text

Respuesta correcta

Si su devolución de llamada es correcta, recibirá una respuesta JSON que tiene el siguiente aspecto:

1 {
2   "access_token":"BEARER_TOKEN",
3   "expires_in":3600,
4   "refresh_token":"REFRESH_TOKEN",
5   "scope":"account.read offline",
6   "token_type":"bearer"
7 }

Ahora puede usar el access_token para realizar llamadas API a Frame.io en nombre del usuario conectado y el refresh_token para solicitar un access_token nuevo cuando este token caduque.