Xojo Plugin
Xojo Plugin
eBay -- Download Data using FileTransferService
See more eBay Examples
Demonstrates how to download a data file using the eBay File Transfer API.Chilkat Xojo Plugin Downloads
Dim success As Boolean
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 ..."
Dim accessToken As String
accessToken = "EBAY_ACCESS_TOKEN"
Dim http As New Chilkat.Http
Dim req As New Chilkat.HttpRequest
req.HttpVerb = "POST"
req.Path = "/FileTransferService"
req.ContentType = "application/xml"
// Build the XML body for the request.
Dim xml As New Chilkat.Xml
xml.Tag = "downloadFileRequest"
success = xml.AddAttribute("xmlns","http://www.ebay.com/marketplace/services")
xml.UpdateChildContent "taskReferenceId","50013004806"
xml.UpdateChildContent "fileReferenceId","50015579016"
success = 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
Dim resp As New Chilkat.HttpResponse
success = http.HttpSReq("storage.sandbox.ebay.com",443,True,req,resp)
If (success = False) Then
System.DebugLog(http.LastErrorText)
Return
End If
Dim statusCode As Int32
statusCode = resp.StatusCode
System.DebugLog("Response status code = " + Str(statusCode))
Dim responseBody As New Chilkat.BinData
success = 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.)
success = responseBody.WriteFile("qa_output/response.mime")
If (statusCode <> 200) Then
System.DebugLog("Failed.")
Return
End If
// 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.
Dim mime As New Chilkat.Mime
success = mime.LoadMimeBd(responseBody)
If (success = False) Then
System.DebugLog(mime.LastErrorText)
Return
End If
// 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
System.DebugLog("Expected the MIME to have 2 parts.")
System.DebugLog("NumParts = " + Str(mime.NumParts))
System.DebugLog("Failed.")
Return
End If
// Get the XML from the 1st MIME sub-part.
Dim part0 As New Chilkat.Mime
success = mime.PartAt(0,part0)
If (success = False) Then
System.DebugLog(mime.LastErrorText)
Return
End If
Dim downloadResponseXml As String
downloadResponseXml = part0.GetBodyDecoded()
Dim xmlResp As New Chilkat.Xml
success = xmlResp.LoadXml(downloadResponseXml)
System.DebugLog("Download Response XML:")
System.DebugLog(xmlResp.GetXml())
System.DebugLog("----")
// Now get the zip from the second part (index=1), unzip, and examine..
Dim part1 As New Chilkat.Mime
success = mime.PartAt(1,part1)
If (success = False) Then
System.DebugLog(mime.LastErrorText)
Return
End If
Dim zipData As New Chilkat.BinData
success = part1.GetBodyBd(zipData)
// Check to see if we have a zip or gzip.
Dim sbContentType As New Chilkat.StringBuilder
success = sbContentType.Append(part1.ContentType)
Dim xmlFromZip As New Chilkat.Xml
If (sbContentType.Contains("gzip",False) = True) Then
// This is a gzip compressed file.
Dim gzip As New Chilkat.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) Then
System.DebugLog(gzip.LastErrorText)
Return
End If
success = xmlFromZip.LoadXml(zipData.GetString("utf-8"))
Else
// This is a zip archive.
// Load the body into a Zip object.
Dim zip As New Chilkat.Zip
success = zip.OpenBd(zipData)
If (success = False) Then
System.DebugLog(zip.LastErrorText)
Return
End If
// Save the .zip to a file (so we can examine it for debugging if something is not as expected)
success = zipData.WriteFile("qa_output/ebay_data.zip")
// The zip should contain a single XML file.
If (zip.NumEntries <> 1) Then
System.DebugLog("Expected the .zip to have 1 entry.")
System.DebugLog("NumEntries = " + Str(zip.NumEntries))
System.DebugLog("Failed.")
Return
End If
Dim entry As New Chilkat.ZipEntry
success = zip.EntryAt(0,entry)
If (success = False) Then
System.DebugLog(zip.LastErrorText)
Return
End If
success = xmlFromZip.LoadXml(entry.UnzipToString(0,"utf-8"))
End If
System.DebugLog("XML contained in the zip:")
System.DebugLog(xmlFromZip.GetXml())
System.DebugLog("----")
System.DebugLog("Success.")