Delphi DLL

SugarCRM Authenticate

See more SugarCRM Examples

Demonstrates how to authenticate to the SugarCRM REST v10 API. This is how an OAuth2 access token is obtained. Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, StringBuilder, Rest, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
rest: HCkRest;
jsonReq: HCkJsonObject;
sbReq: HCkStringBuilder;
sbJson: HCkStringBuilder;
json: HCkJsonObject;
access_token: PWideChar;
expires_in: Integer;
token_type: PWideChar;
scope: Boolean;
refresh_token: PWideChar;
refresh_expires_in: Integer;
download_token: PWideChar;

begin
success := False;

rest := CkRest_Create();

success := CkRest_Connect(rest,'your.site.domain',443,True,True);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

CkRest_AddHeader(rest,'Cache-Control','no-cache');

// The following code creates the JSON request body.
// The JSON created by this code is shown below.
jsonReq := CkJsonObject_Create();
CkJsonObject_UpdateString(jsonReq,'grant_type','password');
CkJsonObject_UpdateString(jsonReq,'client_id','sugar');
CkJsonObject_UpdateString(jsonReq,'client_secret','CLIENT_SECRET');
CkJsonObject_UpdateString(jsonReq,'username','admin');
CkJsonObject_UpdateString(jsonReq,'password','password');
CkJsonObject_UpdateString(jsonReq,'platform','custom_api');

// The JSON request body created by the above code:

// {
//   "grant_type": "password",
//   "client_id": "sugar",
//   "client_secret": "CLIENT_SECRET",
//   "username": "admin",
//   "password": "password",
//   "platform": "custom_api"
// }

sbReq := CkStringBuilder_Create();
CkJsonObject_EmitSb(jsonReq,sbReq);

CkRest_AddHeader(rest,'Content-Type','application/json');

sbJson := CkStringBuilder_Create();
success := CkRest_FullRequestSb(rest,'POST','/rest/v10/oauth2/token',sbReq,sbJson);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

if (CkRest_getResponseStatusCode(rest) <> 200) then
  begin
    Memo1.Lines.Add('Received error response code: ' + IntToStr(CkRest_getResponseStatusCode(rest)));
    Memo1.Lines.Add('Response body:');
    Memo1.Lines.Add(CkStringBuilder__getAsString(sbJson));
    Exit;
  end;

json := CkJsonObject_Create();
CkJsonObject_LoadSb(json,sbJson);

// The following code parses the JSON response.
// A sample JSON response is shown below the sample code.

access_token := CkJsonObject__stringOf(json,'access_token');
expires_in := CkJsonObject_IntOf(json,'expires_in');
token_type := CkJsonObject__stringOf(json,'token_type');
scope := CkJsonObject_IsNullOf(json,'scope');
refresh_token := CkJsonObject__stringOf(json,'refresh_token');
refresh_expires_in := CkJsonObject_IntOf(json,'refresh_expires_in');
download_token := CkJsonObject__stringOf(json,'download_token');

// A sample JSON response body that is parsed by the above code:

// {
//   "access_token": "c6d495c9-bb25-81d2-5f81-533ef6479f9b",
//   "expires_in": 3600,
//   "token_type": "bearer",
//   "scope": null,
//   "refresh_token": "cbc40e67-12bc-4b56-a1d9-533ef62f2601",
//   "refresh_expires_in": 1209600,
//   "download_token": "cc5d1a9f-6627-3349-96e5-533ef6b1a493"
// }

Memo1.Lines.Add('Example Completed.');

CkRest_Dispose(rest);
CkJsonObject_Dispose(jsonReq);
CkStringBuilder_Dispose(sbReq);
CkStringBuilder_Dispose(sbJson);
CkJsonObject_Dispose(json);

end;