Delphi DLL

REST Read Binary Response into BinData Object (Amazon S3)

Demonstrates how to make a REST call that returns a binary response body. This example is valid for files that fit in memory. The example shows how to download a JPG from the Amazon S3 service. Delphi DLL

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

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
rest: HCkRest;
bTls: Boolean;
port: Integer;
bAutoReconnect: Boolean;
authAws: HCkAuthAws;
responseStatusCode: Integer;
errResponse: PWideChar;
bdBody: HCkBinData;

begin
success := False;

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

rest := CkRest_Create();

// Connect to the Amazon AWS REST server.
bTls := True;
port := 443;
bAutoReconnect := True;
success := CkRest_Connect(rest,'s3.amazonaws.com',port,bTls,bAutoReconnect);

// ----------------------------------------------------------------------------
// Important: For buckets created in regions outside us-east-1,
// there are three important changes that need to be made.
// See Working with S3 Buckets in Non-us-east-1 Regions for the details.
// ----------------------------------------------------------------------------

// Provide AWS credentials for the REST call.
authAws := CkAuthAws_Create();
CkAuthAws_putAccessKey(authAws,'AWS_ACCESS_KEY');
CkAuthAws_putSecretKey(authAws,'AWS_SECRET_KEY');
CkAuthAws_putServiceName(authAws,'s3');
success := CkRest_SetAuthAws(rest,authAws);

// Set the bucket name via the HOST header.
// In this case, the bucket name is "chilkat100".
CkRest_putHost(rest,'chilkat100.s3.amazonaws.com');

// Send the request to download the JPG.
success := CkRest_SendReqNoBody(rest,'GET','/starfish.jpg');
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

// Read the response header.
responseStatusCode := CkRest_ReadResponseHeader(rest);
if (responseStatusCode < 0) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

Memo1.Lines.Add('Response status code = ' + IntToStr(responseStatusCode));

// We expect a 200 response status if the JPG data is coming.
// Otherwise, we'll get a string response body with an error message(or no response body).
if (responseStatusCode <> 200) then
  begin
    errResponse := CkRest__readRespBodyString(rest);
    if (CkRest_getLastMethodSuccess(rest) <> True) then
      begin
        Memo1.Lines.Add(CkRest__lastErrorText(rest));
      end
    else
      begin
        Memo1.Lines.Add(errResponse);
      end;
    Exit;
  end;

bdBody := CkBinData_Create();
success := CkRest_ReadRespBd(rest,bdBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

// Save the contents of the response body to a file.
success := CkBinData_WriteFile(bdBody,'qa_output/starfish.jpg');
if (success = True) then
  begin
    Memo1.Lines.Add('Success');
  end
else
  begin
    Memo1.Lines.Add('Failed to write file.');
  end;

CkRest_Dispose(rest);
CkAuthAws_Dispose(authAws);
CkBinData_Dispose(bdBody);

end;