(Unicode C) Frame.io - OAuth2 Access Token

Demonstrates how to get an access token for the Frame.io REST API. This example is for desktop apps only (not web apps).

For more information, see https://docs.frame.io/docs/oauth20-code-flow

Chilkat C/C++ Library Downloads
MS Visual C/C++ Linux/CentOS C/C++ Alpine Linux C/C++ MAC OS X C/C++	armhf/aarch64 C/C++ C++ Builder iOS C/C++ Android C/C++	Solaris C/C++ MinGW C/C++

#include <C_CkOAuth2W.h>
#include <C_CkJsonObjectW.h>
#include <C_CkFileAccessW.h>

void ChilkatSample(void)
    {
    HCkOAuth2W oauth2;
    BOOL success;
    const wchar_t *url;
    int numMsWaited;
    HCkJsonObjectW json;
    HCkFileAccessW fac;

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

    oauth2 = CkOAuth2W_Create();

    // This should be the port in the localhost callback URL for your app.  
    // The callback URL would look like "http://localhost:3017/" if the port number is 3017.
    CkOAuth2W_putListenPort(oauth2,3017);

    CkOAuth2W_putAuthorizationEndpoint(oauth2,L"https://applications.frame.io/oauth2/auth");
    CkOAuth2W_putTokenEndpoint(oauth2,L"https://applications.frame.io/oauth2/token");

    // Replace these with actual values.
    CkOAuth2W_putClientId(oauth2,L"CLIENT_ID");
    CkOAuth2W_putClientSecret(oauth2,L"CLIENT_SECRET");

    // Here's the full list of possible Frame.io scopes:
    // presentation.read
    // project.create
    // presentation.update
    // reviewlink.update
    // team.updat
    // asset.creat
    // presentation.creat
    // project.delet
    // reviewlink.creat
    // comment.rea
    // account.rea
    // team.rea
    // reviewlink.rea
    // asset.rea
    // reviewlink.delet
    // presentation.delet
    // comment.creat
    // asset.delet
    // project.updat
    // team.creat
    // asset.updat
    // offlin
    // comment.updat
    // project.rea
    // comment.delet
    // auditlog.read

    // Request the needed scopes.
    CkOAuth2W_putScope(oauth2,L"offline asset.create asset.read asset.update asset.delete");

    // Frame.io sends the client ID and secret using HTTP basic authentication.
    CkOAuth2W_putUseBasicAuth(oauth2,TRUE);

    // Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
    url = CkOAuth2W_startAuth(oauth2);
    if (CkOAuth2W_getLastMethodSuccess(oauth2) != TRUE) {
        wprintf(L"%s\n",CkOAuth2W_lastErrorText(oauth2));
        CkOAuth2W_Dispose(oauth2);
        return;
    }

    // At this point, your application should load the URL in a browser.
    // For example, 
    // in C#: System.Diagnostics.Process.Start(url);
    // in Java: Desktop.getDesktop().browse(new URI(url));
    // in VBScript: Set wsh=WScript.CreateObject("WScript.Shell")
    //              wsh.Run url
    // in Xojo: ShowURL(url)  (see http://docs.xojo.com/index.php/ShowURL)
    // in Dataflex: Runprogram Background "c:\Program Files\Internet Explorer\iexplore.exe" sUrl        
    // The Microsoft account owner would interactively accept or deny the authorization request.

    // Add the code to load the url in a web browser here...
    // Add the code to load the url in a web browser here...
    // Add the code to load the url in a web browser here...

    // Now wait for the authorization.
    // We'll wait for a max of 30 seconds.
    numMsWaited = 0;
    while ((numMsWaited < 30000) && (CkOAuth2W_getAuthFlowState(oauth2) < 3)) {
        CkOAuth2W_SleepMs(oauth2,100);
        numMsWaited = numMsWaited + 100;
    }

    // If there was no response from the browser within 30 seconds, then 
    // the AuthFlowState will be equal to 1 or 2.
    // 1: Waiting for Redirect. The OAuth2 background thread is waiting to receive the redirect HTTP request from the browser.
    // 2: Waiting for Final Response. The OAuth2 background thread is waiting for the final access token response.
    // In that case, cancel the background task started in the call to StartAuth.
    if (CkOAuth2W_getAuthFlowState(oauth2) < 3) {
        CkOAuth2W_Cancel(oauth2);
        wprintf(L"No response from the browser!\n");
        CkOAuth2W_Dispose(oauth2);
        return;
    }

    // Check the AuthFlowState to see if authorization was granted, denied, or if some error occurred
    // The possible AuthFlowState values are:
    // 3: Completed with Success. The OAuth2 flow has completed, the background thread exited, and the successful JSON response is available in AccessTokenResponse property.
    // 4: Completed with Access Denied. The OAuth2 flow has completed, the background thread exited, and the error JSON is available in AccessTokenResponse property.
    // 5: Failed Prior to Completion. The OAuth2 flow failed to complete, the background thread exited, and the error information is available in the FailureInfo property.
    if (CkOAuth2W_getAuthFlowState(oauth2) == 5) {
        wprintf(L"OAuth2 failed to complete.\n");
        wprintf(L"%s\n",CkOAuth2W_failureInfo(oauth2));
        CkOAuth2W_Dispose(oauth2);
        return;
    }

    if (CkOAuth2W_getAuthFlowState(oauth2) == 4) {
        wprintf(L"OAuth2 authorization was denied.\n");
        wprintf(L"%s\n",CkOAuth2W_accessTokenResponse(oauth2));
        CkOAuth2W_Dispose(oauth2);
        return;
    }

    if (CkOAuth2W_getAuthFlowState(oauth2) != 3) {
        wprintf(L"Unexpected AuthFlowState:%d\n",CkOAuth2W_getAuthFlowState(oauth2));
        CkOAuth2W_Dispose(oauth2);
        return;
    }

    wprintf(L"OAuth2 authorization granted!\n");
    wprintf(L"Access Token = %s\n",CkOAuth2W_accessToken(oauth2));

    // Get the full JSON response:
    json = CkJsonObjectW_Create();
    CkJsonObjectW_Load(json,CkOAuth2W_accessTokenResponse(oauth2));
    CkJsonObjectW_putEmitCompact(json,FALSE);

    // The JSON response 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"
    // }

    wprintf(L"%s\n",CkJsonObjectW_emit(json));

    // Save the JSON to a file for future requests.
    fac = CkFileAccessW_Create();
    CkFileAccessW_WriteEntireTextFile(fac,L"qa_data/tokens/frame_io.json",CkJsonObjectW_emit(json),L"utf-8",FALSE);


    CkOAuth2W_Dispose(oauth2);
    CkJsonObjectW_Dispose(json);
    CkFileAccessW_Dispose(fac);

    }