PHP

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.

Chilkat2 PHP

<?php

use Chilkat2\BinData;
use Chilkat2\Rest;
use Chilkat2\StringBuilder;

// 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 Rest();

// 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 StringBuilder();
$sbPath->Append('/files.xro/1.0/Files/{FileId}/Content');
$numReplaced = $sbPath->Replace('{FileId}', $fileID);

$jpgData = new BinData();
try {
    $rest->FullRequestNoBodyBd('GET', $sbPath->GetAsString(), $jpgData);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\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->ResponseStatusCode != 200) {
    $sbErrorText = new StringBuilder();
    $sbErrorText->AppendBd($jpgData, 'utf-8', 0, 0);
    echo $sbErrorText->GetAsString(), "\n";
    echo "-- Failed.\n";
    exit;
}

// Save to a local file.
try {
    $jpgData->WriteFile('qa_output/xero_penguins.jpg');
} catch (\Chilkat2\Exception $e) {
    echo "Failed to save to local file.\n";
}

echo "Xero Get File was Successful.\n";