Applicazioni OAuth 2

Creazione di un'app OAuth 2

Questa guida presume che tu abbia già registrato un'app OAuth 2

In caso contrario, consulta Flusso del codice OAuth 2 per configurare l’applicazione.

Nozioni di base per l’applicazione

Nota: il client_id e (se non usi PKCE) il client_secret devono essere archiviati in modo sicuro e accessibili tramite l’ambiente. Gli esempi seguenti presuppongono la presenza di un file .env contenente le variabili CLIENT_ID e CLIENT_SECRET.

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

Chiamata del server di autenticazione

Prima di tutto, l’applicazione deve chiamare il server di autenticazione Frame.io, che poi reindirizza l’utente a una pagina di accesso.

Python
1import uuid
2from urllib.parse import urlencode
3
4def 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

Il callback

Il server di autenticazione eseguirà quindi una richiesta GET al REDIRECT_URI, che a sua volta dovrà chiamare il TOKEN_URL. Questo callback sarà leggermente diverso a seconda che l’applicazione sia configurata o meno in modo da usare PKCE.

Senza PKCE

Se non usi PKCE, il callback deve includere un’intestazione Authorization che includa il CLIENT_ID e il CLIENT_SECRET.

Python
1def 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

Se usi PKCE, il callback non deve includere un’intestazione Authorization, ma deve includere il CLIENT_ID nel corpo della richiesta POST quando chiama il TOKEN_URL.

Python
1def 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

Risposta di operazione riuscita

Se il callback riesce, riceverai una risposta JSON simile a questa:

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}

Ora puoi usare l’access_token per effettuare chiamate API a Frame.io per conto dell’utente connesso e il refresh_token per richiedere un nuovo access_token dopo la scadenza di questo token.