.NET Core 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). .NET Core C#

bool success = false;

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

Chilkat.OAuth2 oauth2 = new Chilkat.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.ListenPort = 3017;

oauth2.AuthorizationEndpoint = "https://applications.frame.io/oauth2/auth";
oauth2.TokenEndpoint = "https://applications.frame.io/oauth2/token";

// Replace these with actual values.
oauth2.ClientId = "CLIENT_ID";
oauth2.ClientSecret = "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.
oauth2.Scope = "offline asset.create asset.read asset.update asset.delete";

// Frame.io sends the client ID and secret using HTTP basic authentication.
oauth2.UseBasicAuth = true;

// Begin the OAuth2 three-legged flow.  This returns a URL that should be loaded in a browser.
string url = oauth2.StartAuth();
if (oauth2.LastMethodSuccess == false) {
    Debug.WriteLine(oauth2.LastErrorText);
    return;
}

// Launch the system's default browser navigated to the URL.
success = oauth2.LaunchBrowser(url);
if (success == false) {
    Debug.WriteLine(oauth2.LastErrorText);
    return;
}

// Now wait for the authorization.
// We'll wait for a max of 30 seconds.
int numMsWaited = 0;
while ((numMsWaited < 30000) && (oauth2.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.AuthFlowState < 3) {
    oauth2.Cancel();
    Debug.WriteLine("No response from the browser!");
    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.AuthFlowState == 5) {
    Debug.WriteLine("OAuth2 failed to complete.");
    Debug.WriteLine(oauth2.FailureInfo);
    return;
}

if (oauth2.AuthFlowState == 4) {
    Debug.WriteLine("OAuth2 authorization was denied.");
    Debug.WriteLine(oauth2.AccessTokenResponse);
    return;
}

if (oauth2.AuthFlowState != 3) {
    Debug.WriteLine("Unexpected AuthFlowState:" + Convert.ToString(oauth2.AuthFlowState));
    return;
}

Debug.WriteLine("OAuth2 authorization granted!");
Debug.WriteLine("Access Token = " + oauth2.AccessToken);

// Get the full JSON response:
Chilkat.JsonObject json = new Chilkat.JsonObject();
json.Load(oauth2.AccessTokenResponse);
json.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"
// }

Debug.WriteLine(json.Emit());

// Save the JSON to a file for future requests.
Chilkat.FileAccess fac = new Chilkat.FileAccess();
fac.WriteEntireTextFile("qa_data/tokens/frame_io.json",json.Emit(),"utf-8",false);