(Delphi DLL) Dynamics CRM OAuth2 Access Token

See more OAuth2 Examples

Demonstrates how to get a Microsoft Dynamics CRM OAuth2 access token from a desktop (installed) application or script.

Note: This example requires Chilkat v10.1.2 or greater.

Chilkat for Delphi Downloads

Chilkat non-ActiveX DLL for Delphi

Chilkat ActiveX DLL for Delphi

* The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, CkDateTime, FileAccess, OAuth2, StringBuilder, JsonObject, Http;

...

procedure TForm1.Button1Click(Sender: TObject);
var
oauth2: HCkOAuth2;
url: PWideChar;
http: HCkHttp;
sbPreCheck: HCkStringBuilder;
success: Boolean;
numMsWaited: Integer;
json: HCkJsonObject;
dtExpire: HCkDateTime;
fac: HCkFileAccess;

begin
// To further clarify, see OAuth 2.0 Authorization Flow

oauth2 := CkOAuth2_Create();

// This should be the port in the localhost redirect URL for your app.
// Important: Make sure the redirect URI in your Azure app registration 
// is exactly "http://localhost:3017/".  Don't forget the ending "/" char.
// The redirect URL would look like "http://localhost:3017/" if the port number is 3017.
CkOAuth2_putListenPort(oauth2,3017);

// Get the endpoints from the Azure Portal in the "endpoints" section of App Registrations..
// The DYNAMICS-ENDPOINT-GUID is a Tenant dynamics-endpoint-guid  such as 1b54e7ee-d61b-4f12-a621-a6b2805b98c2
CkOAuth2_putAuthorizationEndpoint(oauth2,'https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/authorize');
CkOAuth2_putTokenEndpoint(oauth2,'https://login.microsoftonline.com/DYNAMICS-ENDPOINT-GUID/oauth2/token');

// Replace these with actual values.
CkOAuth2_putClientId(oauth2,'DYNAMICS-CRM-CLIENT-ID');
CkOAuth2_putClientSecret(oauth2,'DYNAMICS-CRM-SECRET-KEY');

CkOAuth2_putResource(oauth2,'https://mydynamicsdomain.api.crm.dynamics.com');

CkOAuth2_putRedirectAllowHtml(oauth2,'<html><body><p>Thank you for granting access.</p></bod></html>');
CkOAuth2_putRedirectDenyHtml(oauth2,'<html><body><p>Maybe next time...</p></bod></html>');

// Begin the OAuth2 Authorization code flow.  This returns a URL that should be loaded in a browser.
url := CkOAuth2__startAuth(oauth2);
if (CkOAuth2_getLastMethodSuccess(oauth2) <> True) then
  begin
    Memo1.Lines.Add(CkOAuth2__lastErrorText(oauth2));
    Exit;
  end;

// We can pre-check the URL by sending a GET to catch any up-front errors.
// If we receive JSON with an error in response, then we don't proceed any farther.

// If we receive an HTML response, and the response status = 200, then all should be OK.
// We can proceed by displaying an interactive browser loaded with the url.
http := CkHttp_Create();
sbPreCheck := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,url,sbPreCheck);
if ((CkHttp_getLastStatus(http) <> 200) or (CkStringBuilder_StartsWith(sbPreCheck,'{',True) <> True)) then
  begin
    Memo1.Lines.Add('JSON Error Response:');
    Memo1.Lines.Add(CkStringBuilder__getAsString(sbPreCheck));
    Exit;
  end;
// If the HTTP request itself failed, then examine the error.
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;
// OK.. the pre-flight check seems OK, go ahead with getting the interactive user authorization..

// Launch the default browser on the system and navigate to the url.
// The LaunchBrowser method was added in Chilkat v10.1.2.
success := CkOAuth2_LaunchBrowser(oauth2,url);
if (success = False) then
  begin
    Memo1.Lines.Add(CkOAuth2__lastErrorText(oauth2));
    Exit;
  end;

// Wait for the user to approve or deny authorization in the browser.
numMsWaited := 0;
while (numMsWaited < 90000) and (CkOAuth2_getAuthFlowState(oauth2) < 3) do
  begin
    CkOAuth2_SleepMs(oauth2,100);
    numMsWaited := numMsWaited + 100;
  end;

// If the browser does not respond within the specified time, AuthFlowState will be:
// 
// 1: Waiting for Redirect – The OAuth2 background thread is waiting for the browser's redirect request.
// 2: Waiting for Final Response – The thread is awaiting the final access token response.
// In either case, cancel the background task initiated by StartAuth.

if (CkOAuth2_getAuthFlowState(oauth2) < 3) then
  begin
    CkOAuth2_Cancel(oauth2);
    Memo1.Lines.Add('No response from the browser!');
    Exit;
  end;

// Check AuthFlowState to determine if authorization was granted, denied, or failed:
// 
// 3: Success – OAuth2 flow completed, the background thread exited, and the successful response is in AccessTokenResponse.
// 4: Access Denied – OAuth2 flow completed, the background thread exited, and the error response is in AccessTokenResponse.
// 5: Failure – OAuth2 flow failed before completion, the background thread exited, and error details are in FailureInfo.

if (CkOAuth2_getAuthFlowState(oauth2) = 5) then
  begin
    Memo1.Lines.Add('OAuth2 failed to complete.');
    Memo1.Lines.Add(CkOAuth2__failureInfo(oauth2));
    Exit;
  end;

if (CkOAuth2_getAuthFlowState(oauth2) = 4) then
  begin
    Memo1.Lines.Add('OAuth2 authorization was denied.');
    Memo1.Lines.Add(CkOAuth2__accessTokenResponse(oauth2));
    Exit;
  end;

if (CkOAuth2_getAuthFlowState(oauth2) <> 3) then
  begin
    Memo1.Lines.Add('Unexpected AuthFlowState:' + IntToStr(CkOAuth2_getAuthFlowState(oauth2)));
    Exit;
  end;

Memo1.Lines.Add('OAuth2 authorization granted!');
Memo1.Lines.Add('Access Token = ' + CkOAuth2__accessToken(oauth2));

// Get the full JSON response:
json := CkJsonObject_Create();
CkJsonObject_Load(json,CkOAuth2__accessTokenResponse(oauth2));
CkJsonObject_putEmitCompact(json,False);

// The JSON response looks like this:

// {
//   "token_type": "Bearer",
//   "scope": "user_impersonation",
//   "expires_in": "3599",
//   "ext_expires_in": "0",
//   "expires_on": "1524783438",
//   "not_before": "1524779538",
//   "resource": "https://mydomain.api.crm.dynamics.com",
//   "access_token": "...",
//   "refresh_token": "...",
//   "id_token": "..."
// }

// If an "expires_on" member does not exist, then add the JSON member by
// getting the current system date/time and adding the "expires_in" seconds.
// This way we'll know when the token expires.
if (CkJsonObject_HasMember(json,'expires_on') <> True) then
  begin
    dtExpire := CkDateTime_Create();
    CkDateTime_SetFromCurrentSystemTime(dtExpire);
    CkDateTime_AddSeconds(dtExpire,CkJsonObject_IntOf(json,'expires_in'));
    CkJsonObject_AppendString(json,'expires_on',CkDateTime__getAsUnixTimeStr(dtExpire,False));
  end;

Memo1.Lines.Add(CkJsonObject__emit(json));

// Save the JSON to a file for future requests.
fac := CkFileAccess_Create();
CkFileAccess_WriteEntireTextFile(fac,'qa_data/tokens/dynamicsCrm.json',CkJsonObject__emit(json),'utf-8',False);

CkOAuth2_Dispose(oauth2);
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbPreCheck);
CkJsonObject_Dispose(json);
    CkDateTime_Dispose(dtExpire);
CkFileAccess_Dispose(fac);

end;