(Lianja) 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.

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loRest = createobject("CkRest")

// Connect to the Amazon AWS REST server.
llBTls = .T.
lnPort = 443
llBAutoReconnect = .T.
llSuccess = loRest.Connect("s3.amazonaws.com",lnPort,llBTls,llBAutoReconnect)

// ----------------------------------------------------------------------------
// 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.
loAuthAws = createobject("CkAuthAws")
loAuthAws.AccessKey = "AWS_ACCESS_KEY"
loAuthAws.SecretKey = "AWS_SECRET_KEY"
loAuthAws.ServiceName = "s3"
llSuccess = loRest.SetAuthAws(loAuthAws)

// Set the bucket name via the HOST header.
// In this case, the bucket name is "chilkat100".
loRest.Host = "chilkat100.s3.amazonaws.com"

// Send the request to download the JPG.
llSuccess = loRest.SendReqNoBody("GET","/starfish.jpg")
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loRest
    release loAuthAws
    return
endif

// Read the response header.
lnResponseStatusCode = loRest.ReadResponseHeader()
if (lnResponseStatusCode < 0) then
    ? loRest.LastErrorText
    release loRest
    release loAuthAws
    return
endif

? "Response status code = " + str(lnResponseStatusCode)

// 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 (lnResponseStatusCode <> 200) then
    lcErrResponse = loRest.ReadRespBodyString()
    if (loRest.LastMethodSuccess <> .T.) then
        ? loRest.LastErrorText
    else
        ? lcErrResponse
    endif

    release loRest
    release loAuthAws
    return
endif

loBdBody = createobject("CkBinData")
llSuccess = loRest.ReadRespBd(loBdBody)
if (llSuccess = .F.) then
    ? loRest.LastErrorText
    release loRest
    release loAuthAws
    release loBdBody
    return
endif

// Save the contents of the response body to a file.
llSuccess = loBdBody.WriteFile("qa_output/starfish.jpg")
if (llSuccess = .T.) then
    ? "Success"
else
    ? "Failed to write file."
endif



release loRest
release loAuthAws
release loBdBody