C++
C++
eBay -- Download Data using FileTransferService
See more eBay Examples
Demonstrates how to download a data file using the eBay File Transfer API.Chilkat C++ Downloads
#include <CkHttp.h>
#include <CkHttpRequest.h>
#include <CkXml.h>
#include <CkHttpResponse.h>
#include <CkBinData.h>
#include <CkMime.h>
#include <CkStringBuilder.h>
#include <CkGzip.h>
#include <CkZip.h>
#include <CkZipEntry.h>
void ChilkatSample(void)
{
bool 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 ..."
const char *accessToken = "EBAY_ACCESS_TOKEN";
CkHttp http;
CkHttpRequest req;
req.put_HttpVerb("POST");
req.put_Path("/FileTransferService");
req.put_ContentType("application/xml");
// Build the XML body for the request.
CkXml xml;
xml.put_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);
CkHttpResponse resp;
success = http.HttpSReq("storage.sandbox.ebay.com",443,true,req,resp);
if (success == false) {
std::cout << http.lastErrorText() << "\r\n";
return;
}
int statusCode = resp.get_StatusCode();
std::cout << "Response status code = " << statusCode << "\r\n";
CkBinData responseBody;
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) {
std::cout << "Failed." << "\r\n";
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.
CkMime mime;
success = mime.LoadMimeBd(responseBody);
if (success == false) {
std::cout << mime.lastErrorText() << "\r\n";
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.get_NumParts() != 2) {
std::cout << "Expected the MIME to have 2 parts." << "\r\n";
std::cout << "NumParts = " << mime.get_NumParts() << "\r\n";
std::cout << "Failed." << "\r\n";
return;
}
// Get the XML from the 1st MIME sub-part.
CkMime part0;
success = mime.PartAt(0,part0);
if (success == false) {
std::cout << mime.lastErrorText() << "\r\n";
return;
}
const char *downloadResponseXml = part0.getBodyDecoded();
CkXml xmlResp;
xmlResp.LoadXml(downloadResponseXml);
std::cout << "Download Response XML:" << "\r\n";
std::cout << xmlResp.getXml() << "\r\n";
std::cout << "----" << "\r\n";
// Now get the zip from the second part (index=1), unzip, and examine..
CkMime part1;
success = mime.PartAt(1,part1);
if (success == false) {
std::cout << mime.lastErrorText() << "\r\n";
return;
}
CkBinData zipData;
part1.GetBodyBd(zipData);
// Check to see if we have a zip or gzip.
CkStringBuilder sbContentType;
sbContentType.Append(part1.contentType());
CkXml xmlFromZip;
if (sbContentType.Contains("gzip",false) == true) {
// This is a gzip compressed file.
CkGzip gzip;
// in-place uncompress the data.
// Note: The UncompressBd method was added in Chilkat v9.5.0.67
success = gzip.UncompressBd(zipData);
if (success == false) {
std::cout << gzip.lastErrorText() << "\r\n";
return;
}
xmlFromZip.LoadXml(zipData.getString("utf-8"));
}
else {
// This is a zip archive.
// Load the body into a Zip object.
CkZip zip;
success = zip.OpenBd(zipData);
if (success == false) {
std::cout << zip.lastErrorText() << "\r\n";
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.get_NumEntries() != 1) {
std::cout << "Expected the .zip to have 1 entry." << "\r\n";
std::cout << "NumEntries = " << zip.get_NumEntries() << "\r\n";
std::cout << "Failed." << "\r\n";
return;
}
CkZipEntry entry;
success = zip.EntryAt(0,entry);
if (success == false) {
std::cout << zip.lastErrorText() << "\r\n";
return;
}
xmlFromZip.LoadXml(entry.unzipToString(0,"utf-8"));
}
std::cout << "XML contained in the zip:" << "\r\n";
std::cout << xmlFromZip.getXml() << "\r\n";
std::cout << "----" << "\r\n";
std::cout << "Success." << "\r\n";
}