(Tcl) Refresh a Frame.io OAuth2 Access Token

Refreshes a Frame.io OAuth2 access token. When an access token expires, HTTPS requests will receive a 401 status response indicating failure. When that happens, your application can run this code to refresh the access token, and then retry the request using the new access token. Refreshing an access token does not need user interaction (i.e. does not need to display a browser to have the user interactive authorize access).

Note: This example requires Chilkat v9.5.0.84 or greater.

For more information, see https://docs.frame.io/docs/refresh-tokens

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# IMPORTANT: This example requires Chilkat v9.5.0.84 or greater because of an internal modification required to support frame.io
# IMPORTANT: This example requires Chilkat v9.5.0.84 or greater because of an internal modification required to support frame.io
# IMPORTANT: This example requires Chilkat v9.5.0.84 or greater because of an internal modification required to support frame.io

# It is assumed we previously obtained an OAuth2 access token.
# This example loads the JSON access token file 
# saved by this example: Get Frame.io OAuth2 Access Token

set jsonToken [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/frame_io.json"]
if {$success != 1} then {
    puts "Failed to load APP.json"
    delete_CkJsonObject $jsonToken
    exit
}

# The access token JSON looks like this:

# {
#   "access_token": "kwenK_QQnQipMZGtlGreCwrjUxMBr4OX-XAEVA0Q3Rg.yFqYY_c-Mw_k59X1e9rTYR5m-EWf9ivWc1kqmsxR2v4",
#   "expires_in": 3600,
#   "refresh_token": "ZI7XDR0lWoKAXYxPs8BW7bU2IJg3za0zlimMfvTEhUg.pffnx7xye30Eps6OZEYcdzrINFSM3fM5zi78ln7QQ3o",
#   "scope": "offline asset.create asset.read asset.update asset.delete",
#   "token_type": "bearer"
# }

set oauth2 [new_CkOAuth2]

CkOAuth2_put_TokenEndpoint $oauth2 "https://applications.frame.io/oauth2/token"

# Replace these with actual values.
CkOAuth2_put_ClientId $oauth2 "CLIENT_ID"
CkOAuth2_put_ClientSecret $oauth2 "CLIENT_SECRET"

# Frame.io sends the client ID and secret using HTTP basic authentication.
CkOAuth2_put_UseBasicAuth $oauth2 1

# Get the "refresh_token"
CkOAuth2_put_RefreshToken $oauth2 [CkJsonObject_stringOf $jsonToken "refresh_token"]

# Send the HTTP POST to refresh the access token..
set success [CkOAuth2_RefreshAccessToken $oauth2]
if {$success != 1} then {
    puts [CkOAuth2_lastErrorText $oauth2]
    delete_CkJsonObject $jsonToken
    delete_CkOAuth2 $oauth2
    exit
}

puts "New access token: [CkOAuth2_accessToken $oauth2]"
puts "New refresh token: [CkOAuth2_refreshToken $oauth2]"

# Update the JSON with the new tokens.
CkJsonObject_UpdateString $jsonToken "access_token" [CkOAuth2_accessToken $oauth2]
CkJsonObject_UpdateString $jsonToken "refresh_token" [CkOAuth2_refreshToken $oauth2]

# Save the new JSON access token response to a file.
set sbJson [new_CkStringBuilder]

CkJsonObject_put_EmitCompact $jsonToken 0
CkJsonObject_EmitSb $jsonToken $sbJson
CkStringBuilder_WriteFile $sbJson "qa_data/tokens/frame_io.json" "utf-8" 0

puts "OAuth2 token refreshed!"
puts "New Access Token = [CkOAuth2_accessToken $oauth2]"

delete_CkJsonObject $jsonToken
delete_CkOAuth2 $oauth2
delete_CkStringBuilder $sbJson