(JavaScript) eBay -- Download Data using FileTransferService

Demonstrates how to download a data file using the eBay File Transfer API.

Note: This example requires Chilkat v11.0.0 or greater.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var 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 ..."
var accessToken = "EBAY_ACCESS_TOKEN";

var http = new CkHttp();

var req = new CkHttpRequest();

req.HttpVerb = "POST";
req.Path = "/FileTransferService";
req.ContentType = "application/xml";

// Build the XML body for the request.
var xml = new CkXml();
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);

var resp = new CkHttpResponse();
success = http.HttpSReq("storage.sandbox.ebay.com",443,true,req,resp);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var statusCode = resp.StatusCode;
console.log("Response status code = " + statusCode);

var responseBody = new CkBinData();
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) {
    console.log("Failed.");
    return;
}

// 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.
var mime = new CkMime();
success = mime.LoadMimeBd(responseBody);
if (success == false) {
    console.log(mime.LastErrorText);
    return;
}

// 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) {
    console.log("Expected the MIME to have 2 parts.");
    console.log("NumParts = " + mime.NumParts);
    console.log("Failed.");
    return;
}

// Get the XML from the 1st MIME sub-part.

var part0 = new CkMime();
success = mime.PartAt(0,part0);
if (success == false) {
    console.log(mime.LastErrorText);
    return;
}

var downloadResponseXml = part0.GetBodyDecoded();
var xmlResp = new CkXml();
xmlResp.LoadXml(downloadResponseXml);
console.log("Download Response XML:");
console.log(xmlResp.GetXml());

console.log("----");

// Now get the zip from the second part (index=1), unzip, and examine..

var part1 = new CkMime();
success = mime.PartAt(1,part1);
if (success == false) {
    console.log(mime.LastErrorText);
    return;
}

var zipData = new CkBinData();
part1.GetBodyBd(zipData);

// Check to see if we have a zip or gzip.
var sbContentType = new CkStringBuilder();
sbContentType.Append(part1.ContentType);

var xmlFromZip = new CkXml();

if (sbContentType.Contains("gzip",false) == true) {
    // This is a gzip compressed file.
    var gzip = new CkGzip();

    // in-place uncompress the data.
    // Note: The UncompressBd method was added in Chilkat v9.5.0.67
    success = gzip.UncompressBd(zipData);
    if (success == false) {
        console.log(gzip.LastErrorText);
        return;
    }

    xmlFromZip.LoadXml(zipData.GetString("utf-8"));

}
else {
    // This is a zip archive.

    // Load the body into a Zip object.
    var zip = new CkZip();
    success = zip.OpenBd(zipData);
    if (success == false) {
        console.log(zip.LastErrorText);
        return;
    }

    // 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) {
        console.log("Expected the .zip to have 1 entry.");
        console.log("NumEntries = " + zip.NumEntries);
        console.log("Failed.");
        return;
    }

    var entry = new CkZipEntry();
    success = zip.EntryAt(0,entry);
    if (success == false) {
        console.log(zip.LastErrorText);
        return;
    }

    xmlFromZip.LoadXml(entry.UnzipToString(0,"utf-8"));
}

console.log("XML contained in the zip:");
console.log(xmlFromZip.GetXml());
console.log("----");

console.log("Success.");