Pascal (Lazarus/Delphi)
Pascal (Lazarus/Delphi)
eBay -- Download Data using FileTransferService
See more eBay Examples
Demonstrates how to download a data file using the eBay File Transfer API.Chilkat Pascal (Lazarus/Delphi) Downloads
program ChilkatDemo;
// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.
{$IFDEF FPC}
{$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}
uses
{$IFDEF UNIX}
cthreads,
{$ENDIF}
SysUtils,
CkDllLoader,
Chilkat.Mime,
Chilkat.ZipEntry,
Chilkat.Gzip,
Chilkat.HttpResponse,
Chilkat.HttpRequest,
Chilkat.BinData,
Chilkat.StringBuilder,
Chilkat.Zip,
Chilkat.Xml,
Chilkat.Http;
// ---------------------------------------------------------------------------
procedure RunDemo;
var
success: Boolean;
accessToken: string;
http: THttp;
req: THttpRequest;
xml: TXml;
resp: THttpResponse;
statusCode: Integer;
responseBody: TBinData;
mime: TMime;
part0: TMime;
downloadResponseXml: string;
xmlResp: TXml;
part1: TMime;
zipData: TBinData;
sbContentType: TStringBuilder;
xmlFromZip: TXml;
gzip: TGzip;
zip: TZip;
entry: TZipEntry;
begin
success := False;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// Use a previously obtained access token. The token should look something like this:
// "AgAAAA**AQA ..."
accessToken := 'EBAY_ACCESS_TOKEN';
http := THttp.Create;
req := THttpRequest.Create;
req.HttpVerb := 'POST';
req.Path := '/FileTransferService';
req.ContentType := 'application/xml';
// Build the XML body for the request.
xml := TXml.Create;
xml.Tag := 'downloadFileRequest';
xml.AddAttribute('xmlns','http://www.ebay.com/marketplace/services');
xml.UpdateChildContent('taskReferenceId','50013004806');
xml.UpdateChildContent('fileReferenceId','50015579016');
req.LoadBodyFromString(xml.GetXml(),'utf-8');
// The XML body looks like this:
// <?xml version="1.0" encoding="UTF-8"?>
// <downloadFileRequest xmlns="http://www.ebay.com/marketplace/services">
// <taskReferenceId>50013004806</taskReferenceId>
// <fileReferenceId>50015579016</fileReferenceId>
// </downloadFileRequest>
req.AddHeader('X-EBAY-SOA-OPERATION-NAME','downloadFile');
req.AddHeader('X-EBAY-SOA-SECURITY-TOKEN',accessToken);
resp := THttpResponse.Create;
success := http.HttpSReq('storage.sandbox.ebay.com',443,True,req,resp);
if (success = False) then
begin
WriteLn(http.LastErrorText);
Exit;
end;
statusCode := resp.StatusCode;
WriteLn('Response status code = ' + statusCode);
responseBody := TBinData.Create;
resp.GetBodyBd(responseBody);
// We can save the response body to a file for examination if we get an unanticipated response.
// (It's binary, so it won't open well in a text editor.)
responseBody.WriteFile('qa_output/response.mime');
if (statusCode <> 200) then
begin
WriteLn('Failed.');
Exit;
end;
// The response body looks like this:
// --MIMEBoundaryurn_uuid_2B668636C1E17A4D4114925305818684241
// Content-Type: application/xop+xml; charset=utf-8; type="text/xml"
// Content-Transfer-Encoding: binary
// Content-ID: <0.urn:uuid:2B668636C1E17A4D4114925305818684242>
//
// <?xml version='1.0' encoding='UTF-8'?>
// <downloadFileResponse xmlns="http://www.ebay.com/marketplace/services">
// <ack>Success</ack>
// <version>1.1.0</version>
// <timestamp>2017-04-18T15:49:41.868Z</timestamp>
// <fileAttachment>
// <Size>587</Size>
// <Data>
// <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:urn:uuid:A37C3C73E994C267F11492530585522"/>
// </Data>
// </fileAttachment>
// </downloadFileResponse>
// --MIMEBoundaryurn_uuid_2B668636C1E17A4D4114925305818684241
// Content-Type: application/zip
// Content-Transfer-Encoding: binary
// Content-ID: <urn:uuid:A37C3C73E994C267F11492530585522>
//
// <the binary bytes of the zip start here...>
//
// Load the binary response into a MIME object.
mime := TMime.Create;
success := mime.LoadMimeBd(responseBody);
if (success = False) then
begin
WriteLn(mime.LastErrorText);
Exit;
end;
// Make sure we have 2 sub-parts. The 1st sub-part is the XML response, the 2nd sub-part
// is the zip containing the data.
// Note: The 2nd sub-part can be a "zip" or "gzip". These are two different file formats.
// A zip is indicated with a Content-Type header equal to "application/zip",
// whereas a gzip is indicated with a Content-Type header equal to "application/x-gzip"
if (mime.NumParts <> 2) then
begin
WriteLn('Expected the MIME to have 2 parts.');
WriteLn('NumParts = ' + mime.NumParts);
WriteLn('Failed.');
Exit;
end;
// Get the XML from the 1st MIME sub-part.
part0 := TMime.Create;
success := mime.PartAt(0,part0);
if (success = False) then
begin
WriteLn(mime.LastErrorText);
Exit;
end;
downloadResponseXml := part0.GetBodyDecoded();
xmlResp := TXml.Create;
xmlResp.LoadXml(downloadResponseXml);
WriteLn('Download Response XML:');
WriteLn(xmlResp.GetXml());
WriteLn('----');
// Now get the zip from the second part (index=1), unzip, and examine..
part1 := TMime.Create;
success := mime.PartAt(1,part1);
if (success = False) then
begin
WriteLn(mime.LastErrorText);
Exit;
end;
zipData := TBinData.Create;
part1.GetBodyBd(zipData);
// Check to see if we have a zip or gzip.
sbContentType := TStringBuilder.Create;
sbContentType.Append(part1.ContentType);
xmlFromZip := TXml.Create;
if (sbContentType.Contains('gzip',False) = True) then
begin
// This is a gzip compressed file.
gzip := TGzip.Create;
// in-place uncompress the data.
// Note: The UncompressBd method was added in Chilkat v9.5.0.67
success := gzip.UncompressBd(zipData);
if (success = False) then
begin
WriteLn(gzip.LastErrorText);
Exit;
end;
xmlFromZip.LoadXml(zipData.GetString('utf-8'));
end
else
begin
// This is a zip archive.
// Load the body into a Zip object.
zip := TZip.Create;
success := zip.OpenBd(zipData);
if (success = False) then
begin
WriteLn(zip.LastErrorText);
Exit;
end;
// Save the .zip to a file (so we can examine it for debugging if something is not as expected)
zipData.WriteFile('qa_output/ebay_data.zip');
// The zip should contain a single XML file.
if (zip.NumEntries <> 1) then
begin
WriteLn('Expected the .zip to have 1 entry.');
WriteLn('NumEntries = ' + zip.NumEntries);
WriteLn('Failed.');
Exit;
end;
entry := TZipEntry.Create;
success := zip.EntryAt(0,entry);
if (success = False) then
begin
WriteLn(zip.LastErrorText);
Exit;
end;
xmlFromZip.LoadXml(entry.UnzipToString(0,'utf-8'));
end;
WriteLn('XML contained in the zip:');
WriteLn(xmlFromZip.GetXml());
WriteLn('----');
WriteLn('Success.');
http.Free;
req.Free;
xml.Free;
resp.Free;
responseBody.Free;
mime.Free;
part0.Free;
xmlResp.Free;
part1.Free;
zipData.Free;
sbContentType.Free;
xmlFromZip.Free;
gzip.Free;
zip.Free;
entry.Free;
end;
// ---------------------------------------------------------------------------
begin
try
RunDemo;
except
on E: Exception do
WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
end;
WriteLn;
{$IFDEF MSWINDOWS}
WriteLn('Press Enter to exit...');
ReadLn;
{$ENDIF}
end.