(Delphi DLL) REST URL Encode Path Parts and Query Params

See more REST Examples

When passing a path to a Chilkat REST function, the path parts and query params should be URL encoded. This example explains..

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, AuthAws, Rest, StringBuilder;

...

procedure TForm1.Button1Click(Sender: TObject);
var
rest: HCkRest;
bTls: Boolean;
port: Integer;
bAutoReconnect: Boolean;
success: Boolean;
authAws: HCkAuthAws;
path: PWideChar;
sbPath: HCkStringBuilder;
responseJson: PWideChar;

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

// This example demonstrates how to URL encode the path passed to a REST function.
// It is demonstrated with an Amazon SP API GET request to get details about a listings item for a selling partner.
// See https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference#getlistingsitem

rest := CkRest_Create();

// Connect to the REST server.
bTls := True;
port := 443;
bAutoReconnect := True;
success := CkRest_Connect(rest,'sellingpartnerapi-eu.amazon.com',port,bTls,bAutoReconnect);

CkRest_ClearAllQueryParams(rest);
CkRest_AddQueryParam(rest,'marketplaceids','XYZABC123');
CkRest_AddQueryParam(rest,'includedData','offers');

CkRest_AddHeader(rest,'x-amz-access-token','YOUR_ACCESS_TOKEN');

authAws := CkAuthAws_Create();
CkAuthAws_putAccessKey(authAws,'YOUR_AWS_APP_ID');
CkAuthAws_putSecretKey(authAws,'YOUR_AWS_APP_SECRET_KEY');
CkAuthAws_putRegion(authAws,'eu-west-1');
CkAuthAws_putServiceName(authAws,'execute-api');
CkRest_SetAuthAws(rest,authAws);

// The path that is passed to FullRequestNobBody

// Here's a sample path that is not yet URL encoded.
path := '/listings/2022-07-01/items/ABCDEFGHIJ/100x100_28g_LANCETS(BOXED)';

// The path passed to FullRequestNoBody needs to have the parts URL-encoded.
// The "/" chars are not URL encoded, but the individual path parts should be URL encoded.
// For example:  /listings/2022-07-01/items/ABCDEFGHIJ/100x100_28g_LANCETS%28BOXED%29

// In this case, we'll prepare the path like this:
sbPath := CkStringBuilder_Create();
CkStringBuilder_Append(sbPath,'100x100_28g_LANCETS(BOXED)');
// URL encode the contents of the sbPath.
CkStringBuilder_Encode(sbPath,'url','utf-8');
// Prepend the remaining which does not need to be URL encoded.
CkStringBuilder_Prepend(sbPath,'/listings/2022-07-01/items/ABCDEFGHIJ/');

Memo1.Lines.Add('URL encoded path: ' + CkStringBuilder__getAsString(sbPath));

responseJson := CkRest__fullRequestNoBody(rest,'GET',CkStringBuilder__getAsString(sbPath));
if (CkRest_getLastMethodSuccess(rest) <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

Memo1.Lines.Add(responseJson);
Memo1.Lines.Add('----');

CkRest_Dispose(rest);
CkAuthAws_Dispose(authAws);
CkStringBuilder_Dispose(sbPath);

end;