Delphi ActiveX
Delphi ActiveX
eBay -- Download Data using FileTransferService
See more eBay Examples
Demonstrates how to download a data file using the eBay File Transfer API.Chilkat Delphi ActiveX Downloads
uses
Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;
...
procedure TForm1.Button1Click(Sender: TObject);
var
success: Integer;
accessToken: WideString;
http: TChilkatHttp;
req: TChilkatHttpRequest;
xml: TChilkatXml;
resp: TChilkatHttpResponse;
statusCode: Integer;
responseBody: TChilkatBinData;
mime: TChilkatMime;
part0: TChilkatMime;
downloadResponseXml: WideString;
xmlResp: TChilkatXml;
part1: TChilkatMime;
zipData: TChilkatBinData;
sbContentType: TChilkatStringBuilder;
xmlFromZip: TChilkatXml;
gzip: TChilkatGzip;
zip: TChilkatZip;
entry: TChilkatZipEntry;
begin
success := 0;
// 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 := TChilkatHttp.Create(Self);
req := TChilkatHttpRequest.Create(Self);
req.HttpVerb := 'POST';
req.Path := '/FileTransferService';
req.ContentType := 'application/xml';
// Build the XML body for the request.
xml := TChilkatXml.Create(Self);
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 := TChilkatHttpResponse.Create(Self);
success := http.HttpSReq('storage.sandbox.ebay.com',443,1,req.ControlInterface,resp.ControlInterface);
if (success = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
statusCode := resp.StatusCode;
Memo1.Lines.Add('Response status code = ' + IntToStr(statusCode));
responseBody := TChilkatBinData.Create(Self);
resp.GetBodyBd(responseBody.ControlInterface);
// 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
Memo1.Lines.Add('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 := TChilkatMime.Create(Self);
success := mime.LoadMimeBd(responseBody.ControlInterface);
if (success = 0) then
begin
Memo1.Lines.Add(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
Memo1.Lines.Add('Expected the MIME to have 2 parts.');
Memo1.Lines.Add('NumParts = ' + IntToStr(mime.NumParts));
Memo1.Lines.Add('Failed.');
Exit;
end;
// Get the XML from the 1st MIME sub-part.
part0 := TChilkatMime.Create(Self);
success := mime.PartAt(0,part0.ControlInterface);
if (success = 0) then
begin
Memo1.Lines.Add(mime.LastErrorText);
Exit;
end;
downloadResponseXml := part0.GetBodyDecoded();
xmlResp := TChilkatXml.Create(Self);
xmlResp.LoadXml(downloadResponseXml);
Memo1.Lines.Add('Download Response XML:');
Memo1.Lines.Add(xmlResp.GetXml());
Memo1.Lines.Add('----');
// Now get the zip from the second part (index=1), unzip, and examine..
part1 := TChilkatMime.Create(Self);
success := mime.PartAt(1,part1.ControlInterface);
if (success = 0) then
begin
Memo1.Lines.Add(mime.LastErrorText);
Exit;
end;
zipData := TChilkatBinData.Create(Self);
part1.GetBodyBd(zipData.ControlInterface);
// Check to see if we have a zip or gzip.
sbContentType := TChilkatStringBuilder.Create(Self);
sbContentType.Append(part1.ContentType);
xmlFromZip := TChilkatXml.Create(Self);
if (sbContentType.Contains('gzip',0) = 1) then
begin
// This is a gzip compressed file.
gzip := TChilkatGzip.Create(Self);
// in-place uncompress the data.
// Note: The UncompressBd method was added in Chilkat v9.5.0.67
success := gzip.UncompressBd(zipData.ControlInterface);
if (success = 0) then
begin
Memo1.Lines.Add(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 := TChilkatZip.Create(Self);
success := zip.OpenBd(zipData.ControlInterface);
if (success = 0) then
begin
Memo1.Lines.Add(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
Memo1.Lines.Add('Expected the .zip to have 1 entry.');
Memo1.Lines.Add('NumEntries = ' + IntToStr(zip.NumEntries));
Memo1.Lines.Add('Failed.');
Exit;
end;
entry := TChilkatZipEntry.Create(Self);
success := zip.EntryAt(0,entry.ControlInterface);
if (success = 0) then
begin
Memo1.Lines.Add(zip.LastErrorText);
Exit;
end;
xmlFromZip.LoadXml(entry.UnzipToString(0,'utf-8'));
end;
Memo1.Lines.Add('XML contained in the zip:');
Memo1.Lines.Add(xmlFromZip.GetXml());
Memo1.Lines.Add('----');
Memo1.Lines.Add('Success.');
end;