Xbase++ Requires Chilkat v11.0.0+
Xbase++
eBay -- Download Data using FileTransferService
See more eBay Examples
Demonstrates how to download a data file using the eBay File Transfer API.Chilkat Xbase++ Downloads
LOCAL nSuccess
LOCAL cAccessToken
LOCAL oHttp
LOCAL oReq
LOCAL oXml
LOCAL oResp
LOCAL nStatusCode
LOCAL oResponseBody
LOCAL oMime
LOCAL oPart0
LOCAL cDownloadResponseXml
LOCAL oXmlResp
LOCAL oPart1
LOCAL oZipData
LOCAL oSbContentType
LOCAL oXmlFromZip
LOCAL oGzip
LOCAL oZip
LOCAL oEntry
nSuccess := 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 ..."
cAccessToken := "EBAY_ACCESS_TOKEN"
oHttp := CreateObject("Chilkat.Http")
oReq := CreateObject("Chilkat.HttpRequest")
oReq:HttpVerb := "POST"
oReq:Path := "/FileTransferService"
oReq:ContentType := "application/xml"
// Build the XML body for the request.
oXml := CreateObject("Chilkat.Xml")
oXml:Tag := "downloadFileRequest"
oXml:AddAttribute("xmlns", "http://www.ebay.com/marketplace/services")
oXml:UpdateChildContent("taskReferenceId", "50013004806")
oXml:UpdateChildContent("fileReferenceId", "50015579016")
oReq:LoadBodyFromString(oXml: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>
oReq:AddHeader("X-EBAY-SOA-OPERATION-NAME", "downloadFile")
oReq:AddHeader("X-EBAY-SOA-SECURITY-TOKEN", cAccessToken)
oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpSReq("storage.sandbox.ebay.com", 443, 1, oReq, oResp)
IF (nSuccess == 0)
? oHttp:LastErrorText
oHttp:destroy()
oReq:destroy()
oXml:destroy()
oResp:destroy()
RETURN
ENDIF
nStatusCode := oResp:StatusCode
? "Response status code = " + Str(nStatusCode)
oResponseBody := CreateObject("Chilkat.BinData")
oResp:GetBodyBd(oResponseBody)
// 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.)
oResponseBody:WriteFile("qa_output/response.mime")
IF (nStatusCode != 200)
? "Failed."
oHttp:destroy()
oReq:destroy()
oXml:destroy()
oResp:destroy()
oResponseBody:destroy()
RETURN
ENDIF
// 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.
oMime := CreateObject("Chilkat.Mime")
nSuccess := oMime:LoadMimeBd(oResponseBody)
IF (nSuccess == 0)
? oMime:LastErrorText
oHttp:destroy()
oReq:destroy()
oXml:destroy()
oResp:destroy()
oResponseBody:destroy()
oMime:destroy()
RETURN
ENDIF
// 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 (oMime:NumParts != 2)
? "Expected the MIME to have 2 parts."
? "NumParts = " + Str(oMime:NumParts)
? "Failed."
oHttp:destroy()
oReq:destroy()
oXml:destroy()
oResp:destroy()
oResponseBody:destroy()
oMime:destroy()
RETURN
ENDIF
// Get the XML from the 1st MIME sub-part.
oPart0 := CreateObject("Chilkat.Mime")
nSuccess := oMime:PartAt(0, oPart0)
IF (nSuccess == 0)
? oMime:LastErrorText
oHttp:destroy()
oReq:destroy()
oXml:destroy()
oResp:destroy()
oResponseBody:destroy()
oMime:destroy()
oPart0:destroy()
RETURN
ENDIF
cDownloadResponseXml := oPart0:GetBodyDecoded()
oXmlResp := CreateObject("Chilkat.Xml")
oXmlResp:LoadXml(cDownloadResponseXml)
? "Download Response XML:"
? oXmlResp:GetXml()
? "----"
// Now get the zip from the second part (index=1), unzip, and examine..
oPart1 := CreateObject("Chilkat.Mime")
nSuccess := oMime:PartAt(1, oPart1)
IF (nSuccess == 0)
? oMime:LastErrorText
oHttp:destroy()
oReq:destroy()
oXml:destroy()
oResp:destroy()
oResponseBody:destroy()
oMime:destroy()
oPart0:destroy()
oXmlResp:destroy()
oPart1:destroy()
RETURN
ENDIF
oZipData := CreateObject("Chilkat.BinData")
oPart1:GetBodyBd(oZipData)
// Check to see if we have a zip or gzip.
oSbContentType := CreateObject("Chilkat.StringBuilder")
oSbContentType:Append(oPart1:ContentType)
oXmlFromZip := CreateObject("Chilkat.Xml")
IF (oSbContentType:Contains("gzip", 0) == 1)
// This is a gzip compressed file.
oGzip := CreateObject("Chilkat.Gzip")
// in-place uncompress the data.
// Note: The UncompressBd method was added in Chilkat v9.5.0.67
nSuccess := oGzip:UncompressBd(oZipData)
IF (nSuccess == 0)
? oGzip:LastErrorText
oHttp:destroy()
oReq:destroy()
oXml:destroy()
oResp:destroy()
oResponseBody:destroy()
oMime:destroy()
oPart0:destroy()
oXmlResp:destroy()
oPart1:destroy()
oZipData:destroy()
oSbContentType:destroy()
oXmlFromZip:destroy()
oGzip:destroy()
RETURN
ENDIF
oXmlFromZip:LoadXml(oZipData:GetString("utf-8"))
ELSE
// This is a zip archive.
// Load the body into a Zip object.
oZip := CreateObject("Chilkat.Zip")
nSuccess := oZip:OpenBd(oZipData)
IF (nSuccess == 0)
? oZip:LastErrorText
oHttp:destroy()
oReq:destroy()
oXml:destroy()
oResp:destroy()
oResponseBody:destroy()
oMime:destroy()
oPart0:destroy()
oXmlResp:destroy()
oPart1:destroy()
oZipData:destroy()
oSbContentType:destroy()
oXmlFromZip:destroy()
oGzip:destroy()
oZip:destroy()
RETURN
ENDIF
// Save the .zip to a file (so we can examine it for debugging if something is not as expected)
oZipData:WriteFile("qa_output/ebay_data.zip")
// The zip should contain a single XML file.
IF (oZip:NumEntries != 1)
? "Expected the .zip to have 1 entry."
? "NumEntries = " + Str(oZip:NumEntries)
? "Failed."
oHttp:destroy()
oReq:destroy()
oXml:destroy()
oResp:destroy()
oResponseBody:destroy()
oMime:destroy()
oPart0:destroy()
oXmlResp:destroy()
oPart1:destroy()
oZipData:destroy()
oSbContentType:destroy()
oXmlFromZip:destroy()
oGzip:destroy()
oZip:destroy()
RETURN
ENDIF
oEntry := CreateObject("Chilkat.ZipEntry")
nSuccess := oZip:EntryAt(0, oEntry)
IF (nSuccess == 0)
? oZip:LastErrorText
oHttp:destroy()
oReq:destroy()
oXml:destroy()
oResp:destroy()
oResponseBody:destroy()
oMime:destroy()
oPart0:destroy()
oXmlResp:destroy()
oPart1:destroy()
oZipData:destroy()
oSbContentType:destroy()
oXmlFromZip:destroy()
oGzip:destroy()
oZip:destroy()
oEntry:destroy()
RETURN
ENDIF
oXmlFromZip:LoadXml(oEntry:UnzipToString(0, "utf-8"))
ENDIF
? "XML contained in the zip:"
? oXmlFromZip:GetXml()
? "----"
? "Success."
oHttp:destroy()
oReq:destroy()
oXml:destroy()
oResp:destroy()
oResponseBody:destroy()
oMime:destroy()
oPart0:destroy()
oXmlResp:destroy()
oPart1:destroy()
oZipData:destroy()
oSbContentType:destroy()
oXmlFromZip:destroy()
oGzip:destroy()
oZip:destroy()
oEntry:destroy()