OAuth 2 应用程序

构建 OAuth 2 应用程序

本指南假定您已经注册了一个 OAuth 2 应用程序

如果尚未注册，请参考 OAuth 2 授权代码流程来配置您的应用程序。

应用程序基础知识

注意：您应当安全地存储 client_id 和（如果不使用 PKCE）client_secret，并通过您的环境访问它们。以下示例假设存在一个 .env 文件，其中包含变量 CLIENT_ID 和 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"

调用认证服务器

首先，您的应用程序需要调用 Frame.io 认证服务器，然后该服务器会将用户重定向到登录页面。

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

回调

然后，认证服务器会向您的 REDIRECT_URI 发起一个 GET 请求，而该 URI 随后需要调用 TOKEN_URL。此回调会根据您的应用程序是否配置为使用 PKCE 而略有不同。

不使用 PKCE

如果您不使用 PKCE，您的回调必须包含一个 Authorization 标头，其中包括您的 CLIENT_ID 和 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

使用 PKCE

如果您使用 PKCE，您的回调 不得 包含 Authorization 标头，但在回调 TOKEN_URL 时，必须 在POST 请求体中包含您的 CLIENT_ID。

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

成功响应

如果您的回调成功，则会收到一个类似如下的 JSON 响应：

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}

现在，您可以使用 access_token 代表已登录用户向 Frame.io 发起 API 调用，并可以使用 refresh_token 在此令牌过期后请求新的 access_token。