PureBasic

Refresh a Frame.io OAuth2 Access Token

See more Frame.io Examples

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.

PureBasic

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkOAuth2.pb"

Procedure ChilkatExample()

    success.i = 0

    ; 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

    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/frame_io.json")
    If success <> 1
        Debug "Failed to load APP.json"
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    ; 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"
    ; }

    oauth2.i = CkOAuth2::ckCreate()
    If oauth2.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkOAuth2::setCkTokenEndpoint(oauth2, "https://applications.frame.io/oauth2/token")

    ; Replace these with actual values.
    CkOAuth2::setCkClientId(oauth2, "CLIENT_ID")
    CkOAuth2::setCkClientSecret(oauth2, "CLIENT_SECRET")

    ; Frame.io sends the client ID and secret using HTTP basic authentication.
    CkOAuth2::setCkUseBasicAuth(oauth2, 1)

    ; Get the "refresh_token"
    CkOAuth2::setCkRefreshToken(oauth2, CkJsonObject::ckStringOf(jsonToken,"refresh_token"))

    ; Send the HTTP POST to refresh the access token..
    success = CkOAuth2::ckRefreshAccessToken(oauth2)
    If success <> 1
        Debug CkOAuth2::ckLastErrorText(oauth2)
        CkJsonObject::ckDispose(jsonToken)
        CkOAuth2::ckDispose(oauth2)
        ProcedureReturn
    EndIf

    Debug "New access token: " + CkOAuth2::ckAccessToken(oauth2)
    Debug "New refresh token: " + CkOAuth2::ckRefreshToken(oauth2)

    ; Update the JSON with the new tokens.
    CkJsonObject::ckUpdateString(jsonToken,"access_token",CkOAuth2::ckAccessToken(oauth2))
    CkJsonObject::ckUpdateString(jsonToken,"refresh_token",CkOAuth2::ckRefreshToken(oauth2))

    ; Save the new JSON access token response to a file.
    sbJson.i = CkStringBuilder::ckCreate()
    If sbJson.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(jsonToken, 0)
    CkJsonObject::ckEmitSb(jsonToken,sbJson)
    CkStringBuilder::ckWriteFile(sbJson,"qa_data/tokens/frame_io.json","utf-8",0)

    Debug "OAuth2 token refreshed!"
    Debug "New Access Token = " + CkOAuth2::ckAccessToken(oauth2)


    CkJsonObject::ckDispose(jsonToken)
    CkOAuth2::ckDispose(oauth2)
    CkStringBuilder::ckDispose(sbJson)


    ProcedureReturn
EndProcedure