DataFlex

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.

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoJsonToken
    Handle hoOauth2
    Variant vSbJson
    Handle hoSbJson
    String sTemp1

    Move False To iSuccess

    // 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

    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonToken
    If (Not(IsComObjectCreated(hoJsonToken))) Begin
        Send CreateComObject of hoJsonToken
    End
    Get ComLoadFile Of hoJsonToken "qa_data/tokens/frame_io.json" To iSuccess
    If (iSuccess <> True) Begin
        Showln "Failed to load APP.json"
        Procedure_Return
    End

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

    Get Create (RefClass(cComChilkatOAuth2)) To hoOauth2
    If (Not(IsComObjectCreated(hoOauth2))) Begin
        Send CreateComObject of hoOauth2
    End

    Set ComTokenEndpoint Of hoOauth2 To "https://applications.frame.io/oauth2/token"

    // Replace these with actual values.
    Set ComClientId Of hoOauth2 To "CLIENT_ID"
    Set ComClientSecret Of hoOauth2 To "CLIENT_SECRET"

    // Frame.io sends the client ID and secret using HTTP basic authentication.
    Set ComUseBasicAuth Of hoOauth2 To True

    // Get the "refresh_token"
    Get ComStringOf Of hoJsonToken "refresh_token" To sTemp1
    Set ComRefreshToken Of hoOauth2 To sTemp1

    // Send the HTTP POST to refresh the access token..
    Get ComRefreshAccessToken Of hoOauth2 To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoOauth2 To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComAccessToken Of hoOauth2 To sTemp1
    Showln "New access token: " sTemp1
    Get ComRefreshToken Of hoOauth2 To sTemp1
    Showln "New refresh token: " sTemp1

    // Update the JSON with the new tokens.
    Get ComAccessToken Of hoOauth2 To sTemp1
    Get ComUpdateString Of hoJsonToken "access_token" sTemp1 To iSuccess
    Get ComRefreshToken Of hoOauth2 To sTemp1
    Get ComUpdateString Of hoJsonToken "refresh_token" sTemp1 To iSuccess

    // Save the new JSON access token response to a file.
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbJson
    If (Not(IsComObjectCreated(hoSbJson))) Begin
        Send CreateComObject of hoSbJson
    End
    Set ComEmitCompact Of hoJsonToken To False
    Get pvComObject of hoSbJson to vSbJson
    Get ComEmitSb Of hoJsonToken vSbJson To iSuccess
    Get ComWriteFile Of hoSbJson "qa_data/tokens/frame_io.json" "utf-8" False To iSuccess

    Showln "OAuth2 token refreshed!"
    Get ComAccessToken Of hoOauth2 To sTemp1
    Showln "New Access Token = " sTemp1


End_Procedure