(Delphi DLL) Refresh a Square OAuth2 Access Token

Refreshes a Square OAuth2 access token. When an access token expires, HTTPS requests will receive a 401 status response indicating failure. When this happens, your application can run this code to refresh the access token, and then retry the request using the new access token. Refreshing an access token does not need user interaction (i.e. does not need to display a browser to have the user interactive authorize access).

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, OAuth2, StringBuilder, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
jsonToken: HCkJsonObject;
success: Boolean;
oauth2: HCkOAuth2;
sbJson: HCkStringBuilder;

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

// It is assumed we previously obtained an OAuth2 access token.
// This example loads the JSON access token file 
// saved by this example: Get Square OAuth2 Access Token

jsonToken := CkJsonObject_Create();
success := CkJsonObject_LoadFile(jsonToken,'qa_data/tokens/square.json');
if (success <> True) then
  begin
    Memo1.Lines.Add('Failed to load square.json');
    Exit;
  end;

// The access token JSON looks like this:

// {
//   "access_token": "EAAAE...depV",
//   "token_type": "bearer",
//   "expires_at": "2020-09-04T23:30:18Z",
//   "merchant_id": "MLQA83866KSR5",
//   "refresh_token": "EQAAEE...jeVfD6MV"
// }

oauth2 := CkOAuth2_Create();

CkOAuth2_putTokenEndpoint(oauth2,'https://connect.squareupsandbox.com/oauth2/token');

// Replace these with actual values.
CkOAuth2_putClientId(oauth2,'APPLICATION_ID');
CkOAuth2_putClientSecret(oauth2,'APPLICATION_SECRET');

// Get the "refresh_token"
CkOAuth2_putRefreshToken(oauth2,CkJsonObject__stringOf(jsonToken,'refresh_token'));

// Send the HTTP POST to refresh the access token..
success := CkOAuth2_RefreshAccessToken(oauth2);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkOAuth2__lastErrorText(oauth2));
    Exit;
  end;

CkJsonObject_UpdateString(jsonToken,'access_token',CkOAuth2__accessToken(oauth2));

// Save the new JSON access token response to a file.
sbJson := CkStringBuilder_Create();
CkJsonObject_putEmitCompact(jsonToken,False);
CkJsonObject_EmitSb(jsonToken,sbJson);
CkStringBuilder_WriteFile(sbJson,'qa_data/tokens/square.json','utf-8',False);

Memo1.Lines.Add('OAuth2 token refreshed!');
Memo1.Lines.Add('New Access Token = ' + CkOAuth2__accessToken(oauth2));

CkJsonObject_Dispose(jsonToken);
CkOAuth2_Dispose(oauth2);
CkStringBuilder_Dispose(sbJson);

end;