Aplicativos OAuth 2

Criação de um aplicativo OAuth 2

Este guia pressupõe que você já tenha registrado um aplicativo OAuth 2.

Caso contrário, consulte o Fluxo de código do OAuth 2 para configurar seu aplicativo.

Noções básicas sobre o aplicativo

Observação: você deve armazenar seu client_id e (caso não esteja usando PKCE) seu client_secret de forma segura e acessá-los por meio do seu ambiente.Os exemplos abaixo pressupõem a existência de um arquivo .env contendo as variáveis 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"

Chamando o servidor de autenticação

Primeiro, seu aplicativo precisará chamar o servidor de autenticação do Frame.io, que, em seguida, redirecionará o usuário para uma página de login.

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

O callback

O servidor de autenticação fará uma solicitação GET para o seu REDIRECT_URI, que por sua vez precisará chamar o TOKEN_URL.Esse callback será ligeiramente diferente dependendo se o seu aplicativo está ou não configurado para usar PKCE.

Sem PKCE

Se você não estiver usando PKCE, seu callback deve incluir um cabeçalho Authorization que contenha seu CLIENT_ID e 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

Com PKCE

Se você estiver usando PKCE, seu callback não deve incluir um cabeçalho Authorization mas deve incluir seu CLIENT_ID no corpo da solicitação POST ao fazer o callback para o 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

Resposta bem-sucedida

Se o seu callback for bem-sucedido, você receberá uma resposta JSON semelhante a esta:

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}

Agora você pode usar o access_token para fazer chamadas de API ao Frame.io em nome do usuário conectado e o refresh_token para solicitar um novo access_token após a expiração deste token.