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

import urllib, requests, requests.auth
import os
CLIENT_ID = os.environ.get('CLIENT_ID')
CLIENT_SECRET = os.environ.get('CLIENT_SECRET')
AUTHORIZE_URL = "https://applications.frame.io/oauth2/auth"
TOKEN_URL = "https://applications.frame.io/oauth2/token"
# The scopes you've chosen for your app, space-delimited
SCOPE = "offline account.read asset.read" 
# The callback URI for your app
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

import uuid
from urllib.parse import urlencode
def create_auth_url():
 credentials = {
  'response_type': 'code',
  'redirect_uri': REDIRECT_URI,
  'client_id': CLIENT_ID,
  'scope': SCOPE,
  'state': str(uuid.uuid4())
 }
 url = (AUTHORIZE_URL + "?" + urlencode(credentials))
 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

def callback():
   state = request.args.get('state')
   scope = request.args.get('scope')
   code = request.args.get('code')
   error = request.args.get('error')
   if error:
     return "Error: " + error
   # Set up for client authorization and set up the data you need to send.
   client_auth = requests.auth.HTTPBasicAuth(CLIENT_ID, CLIENT_SECRET)
   post_data = {
     "grant_type": "authorization_code",
     "code": code,
     "redirect_uri": REDIRECT_URI,
     "state": state,
     "scope": SCOPE
   }
# Send a POST request with the data you need to receive an access token. 
# If everything goes well, it will be returned to you and you can use it with
# Frame.io.
   response = requests.post(TOKEN_URL, auth=client_auth, data=post_data)    
   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

def callback():
   state = request.args.get('state')
   scope = request.args.get('scope')
   code = request.args.get('code')
   error = request.args.get('error')
   if error:
     return "Error: " + error
# If using PKCE, you must include the CLIENT_ID in your request body  
   post_data = {
     "grant_type": "authorization_code",
     "code": code,
     "redirect_uri": REDIRECT_URI,
     "state": state,
     "scope": SCOPE
     "client_id": CLIENT_ID 
   }
# Send a POST request with the data you need to receive an access token. 
# If everything goes well, it will be returned to you and you can use it with
# Frame.io
  # If using PKCE, use the below request with no auth
  response = requests.post(TOKEN_URL, data=post_data) 
   return response.text

Respuesta correcta

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

{
  "access_token":"BEARER_TOKEN",
  "expires_in":3600,
  "refresh_token":"REFRESH_TOKEN",
  "scope":"account.read offline",
  "token_type":"bearer"
}

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.