(PHP Extension) Xero Get File Content (Files API)

Demonstrates how to download the content of a Xero file.

Note: This example requires Chilkat v9.5.0.64 or greater.

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");

// Note: Requires Chilkat v9.5.0.64 or greater.

// This requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$rest = new CkRest();

// Before sending REST API calls, the REST object needs to be
// initialized for OAuth1.
// See Xero 2-Legged OAuth1 Setup for sample code.

// Assuming the REST object's OAuth1 authenticator is setup, and the initial
// connection was made, we may now send REST HTTP requests..

// ------------------------------------------------------------------------------
$fileID = 'f042e9a3-a31d-4595-b8b3-6030ea6084bb';

$sbPath = new CkStringBuilder();
$sbPath->Append('/files.xro/1.0/Files/{FileId}/Content');
$numReplaced = $sbPath->Replace('{FileId}',$fileID);

$jpgData = new CkBinData();
$success = $rest->FullRequestNoBodyBd('GET',$sbPath->getAsString(),$jpgData);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

// A 200 response is expected for actual success.
// If we don't get a 200 response, then the response body was not actually
// the file data, but it was text containing error information.
if ($rest->get_ResponseStatusCode() != 200) {
    $sbErrorText = new CkStringBuilder();
    $sbErrorText->AppendBd($jpgData,'utf-8',0,0);
    print $sbErrorText->getAsString() . "\n";
    print '-- Failed.' . "\n";
    exit;
}

// Save to a local file.
$success = $jpgData->WriteFile('qa_output/xero_penguins.jpg');
if ($success != true) {
    print 'Failed to save to local file.' . "\n";
}

print 'Xero Get File was Successful.' . "\n";

?>