tigron/codabox-gateway

Fetch CODA files from Codabox via the Tigron Restfull API

codabox-gateway

Description

Fetch CODA files from Codabox via the Tigron REST gateway. For more information on this service, visit: https://codabox.tigron.net, _(*1)

Installation

installation via composer:, _(*2)

composer require tigron/codabox-gateway

Howto

Configure your Connection:, _(*3)

\Tigron\Codabox\Config::$key = 'YOUR_API_KEY';

Get 1 CODA file by its ID:, _(*4)

$coda_files = \Tigron\Codabox\Coda::get_by_id('00000000-0000-0000-0000-000000000000');

Get all CODA files for a specified year:, _(*5)

$coda_files = \Tigron\Codabox\Coda::get_by_year(2018);

Get unprocessed CODA files:, _(*6)

$coda_files = \Tigron\Codabox\Coda::get_unprocessed();

Mark a CODA file as 'processed':, _(*7)

$coda = \Tigron\Codabox\Coda::get_by_id('00000000-0000-0000-0000-000000000000');
$coda->mark_processed();

Mark a CODA file as 'unprocessed':, _(*8)

$coda = \Tigron\Codabox\Coda::get_by_id('00000000-0000-0000-0000-000000000000');
$coda->mark_unprocessed();