Создание приложения OAuth 2

Это руководство предполагает, что вы уже зарегистрировали приложение OAuth 2

Если нет, обратитесь к Потоку кода OAuth 2 для настройки вашего приложения.

Основы приложения

Примечание. Необходимо надежно хранить ваши client_id и (если не используете PKCE) client_secret и получать к ним доступ через свою среду. Приведенные ниже примеры предполагают наличие файла .env, содержащего переменные CLIENT_ID и 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"

Вызов сервера аутентификации

Сначала ваше приложение должно вызвать сервер аутентификации Frame.io, который затем перенаправит пользователя на страницу входа.

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

Обратный вызов

Затем сервер аутентификации выполнит запрос GET запрос к вашему REDIRECT_URI, который в свою очередь должен будет вызвать TOKEN_URL. Этот обратный вызов будет немного отличаться в зависимости от того, настроено ли приложение для использования PKCE.

Без PKCE

Если вы не используете PKCE, обратный вызов должен включать заголовок Авторизация, который содержит ваши CLIENT_ID и 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

С PKCE

Если вы используете PKCE, ваш обратный вызов не должен включать заголовок Авторизация, но должен содержать ваш CLIENT_ID в теле запроса POST при обращении к 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

Ответ выполнен

Если ваш обратный вызов выполнен, вы получите ответ JSON, который выглядит следующим образом:

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

Теперь можно использовать access_token для выполнения вызовов API к Frame.io от имени вошедшего в систему пользователя, а refresh_token — для запроса нового access_token после истечения срока действия этого токена.