(Objective-C) eBay -- Download Data using FileTransferService

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

Note: This example requires Chilkat v9.5.0.67 or later.

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <NSString.h>
#import <CkoHttp.h>
#import <CkoHttpRequest.h>
#import <CkoXml.h>
#import <CkoHttpResponse.h>
#import <CkoBinData.h>
#import <CkoMime.h>
#import <CkoStringBuilder.h>
#import <CkoGzip.h>
#import <CkoZip.h>
#import <CkoZipEntry.h>

// 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 ..."
NSString *accessToken = @"EBAY_ACCESS_TOKEN";

CkoHttp *http = [[CkoHttp alloc] init];

CkoHttpRequest *req = [[CkoHttpRequest alloc] init];

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

// Build the XML body for the request.
CkoXml *xml = [[CkoXml alloc] init];
xml.Tag = @"downloadFileRequest";
[xml AddAttribute: @"xmlns" value: @"http://www.ebay.com/marketplace/services"];
[xml UpdateChildContent: @"taskReferenceId" value: @"50013004806"];
[xml UpdateChildContent: @"fileReferenceId" value: @"50015579016"];

[req LoadBodyFromString: [xml GetXml] charset: @"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" value: @"downloadFile"];
[req AddHeader: @"X-EBAY-SOA-SECURITY-TOKEN" value: accessToken];

CkoHttpResponse *resp = [http SynchronousRequest: @"storage.sandbox.ebay.com" port: [NSNumber numberWithInt: 443] ssl: YES req: req];
if (http.LastMethodSuccess != YES) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

int statusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response status code = ",statusCode);

CkoBinData *responseBody = [[CkoBinData alloc] init];
[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) {
    NSLog(@"%@",@"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.
CkoMime *mime = [[CkoMime alloc] init];
BOOL success = [mime LoadMimeBd: responseBody];
if (success != YES) {
    NSLog(@"%@",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 intValue] != 2) {
    NSLog(@"%@",@"Expected the MIME to have 2 parts.");
    NSLog(@"%@%d",@"NumParts = ",[mime.NumParts intValue]);
    NSLog(@"%@",@"Failed.");
    return;
}

// Get the XML from the 1st MIME sub-part.
CkoMime *part0 = [mime GetPart: [NSNumber numberWithInt: 0]];
NSString *downloadResponseXml = [part0 GetBodyDecoded];
CkoXml *xmlResp = [[CkoXml alloc] init];
[xmlResp LoadXml: downloadResponseXml];
NSLog(@"%@",@"Download Response XML:");
NSLog(@"%@",[xmlResp GetXml]);

NSLog(@"%@",@"----");

// Now get the zip from the second part (index=1), unzip, and examine..
CkoMime *part1 = [mime GetPart: [NSNumber numberWithInt: 1]];
CkoBinData *zipData = [[CkoBinData alloc] init];
// This example requires Chilkat v9.5.0.67 or later.
// The GetBodyBd method was added in v9.5.0.67.
[part1 GetBodyBd: zipData];

// Check to see if we have a zip or gzip.
CkoStringBuilder *sbContentType = [[CkoStringBuilder alloc] init];
[sbContentType Append: part1.ContentType];

CkoXml *xmlFromZip = [[CkoXml alloc] init];

if ([sbContentType Contains: @"gzip" caseSensitive: NO] == YES) {
    // This is a gzip compressed file.
    CkoGzip *gzip = [[CkoGzip alloc] init];

    // in-place uncompress the data.
    // Note: The UncompressBd method was added in Chilkat v9.5.0.67
    success = [gzip UncompressBd: zipData];
    if (success != YES) {
        NSLog(@"%@",gzip.LastErrorText);
        return;
    }

    [xmlFromZip LoadXml: [zipData GetString: @"utf-8"]];

}
else {
    // This is a zip archive.

    // Load the body into a Zip object.
    CkoZip *zip = [[CkoZip alloc] init];
    success = [zip OpenBd: zipData];
    if (success != YES) {
        NSLog(@"%@",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 intValue] != 1) {
        NSLog(@"%@",@"Expected the .zip to have 1 entry.");
        NSLog(@"%@%d",@"NumEntries = ",[zip.NumEntries intValue]);
        NSLog(@"%@",@"Failed.");
        return;
    }

    CkoZipEntry *entry = [zip GetEntryByIndex: [NSNumber numberWithInt: 0]];

    [xmlFromZip LoadXml: [entry UnzipToString: [NSNumber numberWithInt: 0] srcCharset: @"utf-8"]];

}

NSLog(@"%@",@"XML contained in the zip:");
NSLog(@"%@",[xmlFromZip GetXml]);
NSLog(@"%@",@"----");

NSLog(@"%@",@"Success.");