C++

Frame.io - OAuth2 Access Token

See more Frame.io Examples

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

#include <CkOAuth2.h>
#include <CkJsonObject.h>
#include <CkFileAccess.h>

void ChilkatSample(void)
    {
    bool success = false;

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

    CkOAuth2 oauth2;

    //  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.
    oauth2.put_ListenPort(3017);

    oauth2.put_AuthorizationEndpoint("https://applications.frame.io/oauth2/auth");
    oauth2.put_TokenEndpoint("https://applications.frame.io/oauth2/token");

    //  Replace these with actual values.
    oauth2.put_ClientId("CLIENT_ID");
    oauth2.put_ClientSecret("CLIENT_SECRET");

    //  Here's the full list of possible Frame.io scopes:
    //  presentation.read
    //  project.create
    //  presentation.update
    //  reviewlink.update
    //  team.update
    //  asset.create
    //  presentation.create
    //  project.delete
    //  reviewlink.create
    //  comment.read
    //  account.read
    //  team.read
    //  reviewlink.read
    //  asset.read
    //  reviewlink.delete
    //  presentation.delete
    //  comment.create
    //  asset.delete
    //  project.update
    //  team.create
    //  asset.update
    //  offline
    //  comment.update
    //  project.read
    //  comment.delete
    //  auditlog.read

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

    //  Frame.io sends the client ID and secret using HTTP basic authentication.
    oauth2.put_UseBasicAuth(true);

    //  Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
    const char *url = oauth2.startAuth();
    if (oauth2.get_LastMethodSuccess() == false) {
        std::cout << oauth2.lastErrorText() << "\r\n";
        return;
    }

    //  Launch the system's default browser navigated to the URL.
    success = oauth2.LaunchBrowser(url);
    if (success == false) {
        std::cout << oauth2.lastErrorText() << "\r\n";
        return;
    }

    //  Now wait for the authorization.
    //  We'll wait for a max of 30 seconds.
    int numMsWaited = 0;
    while ((numMsWaited < 30000) && (oauth2.get_AuthFlowState() < 3)) {
        oauth2.SleepMs(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 (oauth2.get_AuthFlowState() < 3) {
        oauth2.Cancel();
        std::cout << "No response from the browser!" << "\r\n";
        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 (oauth2.get_AuthFlowState() == 5) {
        std::cout << "OAuth2 failed to complete." << "\r\n";
        std::cout << oauth2.failureInfo() << "\r\n";
        return;
    }

    if (oauth2.get_AuthFlowState() == 4) {
        std::cout << "OAuth2 authorization was denied." << "\r\n";
        std::cout << oauth2.accessTokenResponse() << "\r\n";
        return;
    }

    if (oauth2.get_AuthFlowState() != 3) {
        std::cout << "Unexpected AuthFlowState:" << oauth2.get_AuthFlowState() << "\r\n";
        return;
    }

    std::cout << "OAuth2 authorization granted!" << "\r\n";
    std::cout << "Access Token = " << oauth2.accessToken() << "\r\n";

    //  Get the full JSON response:
    CkJsonObject json;
    json.Load(oauth2.accessTokenResponse());
    json.put_EmitCompact(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"
    //  }

    std::cout << json.emit() << "\r\n";

    //  Save the JSON to a file for future requests.
    CkFileAccess fac;
    fac.WriteEntireTextFile("qa_data/tokens/frame_io.json",json.emit(),"utf-8",false);
    }