Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

PHP Extension Web API Examples

Primary Categories

ABN AMRO
AWS Secrets Manager
AWS Security Token Service
AWS Translate
Activix CRM
Adyen
Alibaba Cloud OSS
Amazon Cognito
Amazon DynamoDB
Amazon MWS
Amazon Pay
Amazon Rekognition
Amazon SP-API
Amazon Voice ID
Aruba Fatturazione
Azure Maps
Azure Monitor
Azure OAuth2
Azure Storage Accounts
Backblaze S3
Banco Inter
Belgian eHealth Platform
Bitfinex v2 REST
Bluzone
BrickLink
Bunny CDN
CallRail
CardConnect
Cerved
ClickBank
Clickatell
Cloudfare
Constant Contact
DocuSign
Duo Auth MFA
ETrade
Ecwid
Egypt ITIDA
Egypt eReceipt
Etsy
Facebook
Faire
Frame.io
GeoOp
GetHarvest
Global Payments
Google People
Google Search Console
Google Translate
Hungary NAV Invoicing
IBM Text to Speech
Ibanity
IntakeQ
Jira
Lightspeed
MYOB
Magento
Mailgun
Mastercard

MedTunnel
MercadoLibre
MessageMedia
Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans
Microsoft Teams
Moody's
Okta OAuth/OIDC
OneLogin OIDC
OneNote
OpenAI ChatGPT
PRODA
PayPal
Paynow.pl
Peoplevox
Populi
QuickBooks
Rabobank
Refinitiv
Royal Mail OBA
SCiS Schools Catalogue
SII Chile
SMSAPI
SOAP finkok.com
SendGrid
Shippo
Shopify
Shopware
Shopware 6
SimpleTexting
Square
Stripe
SugarCRM
TicketBAI
Trello
Twilio
Twitter API v2
Twitter v1
UPS
UniPin
VoiceBase
Vonage
WaTrend
Walmart v3
Wasabi
WhatsApp
WiX
WooCommerce
WordPress
Xero
Yahoo Mail
Yapily
Yousign
ZATCA
Zendesk
Zoom
_Miscellaneous_
eBay
effectconnect
hacienda.go.cr

 

 

 

(PHP Extension) 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 PHP Downloads

PHP Extension for Windows, Linux, MacOS,
Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// 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 ..."
$accessToken = 'EBAY_ACCESS_TOKEN';

$http = new CkHttp();

$req = new CkHttpRequest();

$req->put_HttpVerb('POST');
$req->put_Path('/FileTransferService');
$req->put_ContentType('application/xml');

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

// resp is a CkHttpResponse
$resp = $http->SynchronousRequest('storage.sandbox.ebay.com',443,true,$req);
if ($http->get_LastMethodSuccess() != true) {
    print $http->lastErrorText() . "\n";
    exit;
}

$statusCode = $resp->get_StatusCode();
print 'Response status code = ' . $statusCode . "\n";

$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) {
    print 'Failed.' . "\n";
    exit;
}

// 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.
$mime = new CkMime();
$success = $mime->LoadMimeBd($responseBody);
if ($success != true) {
    print $mime->lastErrorText() . "\n";
    exit;
}

// 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) {
    print 'Expected the MIME to have 2 parts.' . "\n";
    print 'NumParts = ' . $mime->get_NumParts() . "\n";
    print 'Failed.' . "\n";
    exit;
}

// Get the XML from the 1st MIME sub-part.
// part0 is a CkMime
$part0 = $mime->GetPart(0);
$downloadResponseXml = $part0->getBodyDecoded();
$xmlResp = new CkXml();
$xmlResp->LoadXml($downloadResponseXml);
print 'Download Response XML:' . "\n";
print $xmlResp->getXml() . "\n";

print '----' . "\n";

// Now get the zip from the second part (index=1), unzip, and examine..
// part1 is a CkMime
$part1 = $mime->GetPart(1);
$zipData = new CkBinData();
// 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.
$sbContentType = new CkStringBuilder();
$sbContentType->Append($part1->contentType());

$xmlFromZip = new CkXml();

if ($sbContentType->Contains('gzip',false) == true) {
    // This is a gzip compressed file.
    $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 != true) {
        print $gzip->lastErrorText() . "\n";
        exit;
    }

    $xmlFromZip->LoadXml($zipData->getString('utf-8'));

}
else {
    // This is a zip archive.

    // Load the body into a Zip object.
    $zip = new CkZip();
    $success = $zip->OpenBd($zipData);
    if ($success != true) {
        print $zip->lastErrorText() . "\n";
        exit;
    }

    // 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) {
        print 'Expected the .zip to have 1 entry.' . "\n";
        print 'NumEntries = ' . $zip->get_NumEntries() . "\n";
        print 'Failed.' . "\n";
        exit;
    }

    // entry is a CkZipEntry
    $entry = $zip->GetEntryByIndex(0);

    $xmlFromZip->LoadXml($entry->unzipToString(0,'utf-8'));

}

print 'XML contained in the zip:' . "\n";
print $xmlFromZip->getXml() . "\n";
print '----' . "\n";

print 'Success.' . "\n";

?>

 

© 2000-2024 Chilkat Software, Inc. All Rights Reserved.