theimagingsource/tisd-sdk

PHP wrapper for The Imaging Source Download System Web API. Authored and supported by The Imaging Source Europe GmbH.

, _(*1)

PHP Wrapper for The Imaging Source Download System Web API

, _(*2)

The Imaging Source produces a large number of downloadable files (drivers, end-user software, documentation, images etc.). These resources are published at dl.theimagingsource.com and are available via a JSON-based API. In addition to encapsulating the functionality of the JSON-based API, this component library provides several helper objects to make access to The Imaging Source downloads as simple and quick as possible., _(*3)

Installation

Use Composer to install the SDK:, _(*4)

composer require theimagingsource/tisd-sdk ^5.0, _(*5)

Sample Endpoints

Return all supported locales

• https://dl.theimagingsource.com/api/2.5/packages/en_US.json

Return all supported contexts

• https://dl.theimagingsource.com/api/2.5/contexts/en_US.json

Return meta information and statistics

• https://dl.theimagingsource.com/api/2.5/meta/en_US.json

Return all data (consolidated)

• https://dl.theimagingsource.com/api/2.5/consolidated/en_US.json

Return all packages in "Downloads"

• https://dl.theimagingsource.com/api/2.5/packages/downloads/en_US.json

Return all packages in "Downloads" -> "Drivers"

• https://dl.theimagingsource.com/api/2.5/packages/downloads/drivers/en_US.json

Return package matching product code ID

• https://dl.theimagingsource.com/api/2.5/get-package-by-product-code-id/icwdmuvccamtis/en_US.json

Return package matching package ID

• https://dl.theimagingsource.com/api/2.5/get-package-by-package-id/icwdmuvccamtis/en_US.json

Return package matching UUID

• https://dl.theimagingsource.com/api/2.5/get-package-by-uuid/059f8cbe-9a03-5ad8-809e-90b33380a673.json

Programming Samples

The SDK ships with comprehensive samples illustrating all functionality. Please take a look in the /bin directory., _(*6)

Unit Tests

The SDK ships with complete unit tests. Simply run composer test in the root directory., _(*7)

JSON Structure

root
  categories
    sections
      packages
        package

Loop through the JSON structure in PHP

getPackages();

foreach ($packages['children'] as $categoryId => $categories) {
    foreach ($categories['children'] as $sectionId => $sections) {
        foreach ($sections['children'] as $packageId => $package) {
            // $latestPackageVersion = array_shift($package['versions']);
        }
    }
}

foreach ($packages['children'] as $categoryId => $categories) {
    foreach ($categories['children'] as $sectionId => $sections) {
        foreach ($sections['children'] as $packageId => $package) {
            // $latestPackageVersion = array_shift($package['versions']);
        }
        if (0 === count($packages['children'][$categoryId]['children'][$sectionId]['children'])) {
            unset($packages['children'][$categoryId]['children'][$sectionId]);
        }
    }
    if (0 === count($packages['children'][$categoryId]['children'])) {
        unset($packages['children'][$categoryId]);
    }
}

?>