PHPackages                             der-spiegel/amendo-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Image &amp; Media](/categories/media)
4. /
5. der-spiegel/amendo-client

ActiveLibrary[Image &amp; Media](/categories/media)

der-spiegel/amendo-client
=========================

PHP client for OneVision Amendo https://www.onevision.com/solutions/image-editing/amendo/

v2.4.0(5mo ago)01.7kMITPHPPHP ^8.4

Since Nov 16Pushed 5mo ago3 watchersCompare

[ Source](https://github.com/DerSpiegel/amendo_php_client)[ Packagist](https://packagist.org/packages/der-spiegel/amendo-client)[ Docs](https://github.com/DerSpiegel/amendo_php_client)[ RSS](/packages/der-spiegel-amendo-client/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (3)Versions (14)Used By (0)

A PHP client for OneVision Amendo
=================================

[](#a-php-client-for-onevision-amendo)

[OneVision Amendo](https://www.onevision.com/solutions/image-editing/amendo/)is automated image enhancement software. This PHP client library uses its REST API.

This is not an official library supplied by the OneVision vendor. It has been developed for the WoodWing Assets project at the German [SPIEGEL Gruppe](https://www.spiegelgruppe.de), 2020.

Installation
------------

[](#installation)

Use [Composer](https://getcomposer.org/) to add this library your project’s composer.json file:

```
$ composer require der-spiegel/amendo-client

```

Developing this library
-----------------------

[](#developing-this-library)

If you want to help developing this library, Here’s how to get started (Docker required):

### Install dependencies using Composer

[](#install-dependencies-using-composer)

```
$ docker run --rm --interactive --tty \
  --volume $PWD:/app \
  --volume ${COMPOSER_HOME:-$HOME/.composer}:/tmp \
  composer/composer install

```

### Use the library

[](#use-the-library)

The `UsageExample.php` example script can be used without modification by setting the environment variable `AMENDO_SERVER` to the Amendo server base URL, `AMENDO_ASSEMBLYLINE` the name of the Amendo assembly line and `AMENDO_FILEPATH` to a file path, that should be processed by the assembly line.

The script will create a new job for the specified file using the specified assembly line. Some custom job and file properties are submitted with the job ticket to the Amendo server, that can be used to configure modules used in the assembly line.

For more advanced usage create a copy of the `UsageExample.php` example file

`$ cp UsageExample.php MyExample.php`

and modify the copied file accordingly.

#### Example source code explained

[](#example-source-code-explained)

**Create an AmendoConfig object refering to the Amendo server:**

```
$amendoConfig = new AmendoConfig($amendoServerUrl);
```

**Create an AmendoClient object using the AmendoConfig object:**

```
$amendoClient = new AmendoClient($amendoConfig, $logger);
```

**Create a SimpleJobTicket object:**

```
$jobTicket = new SimpleJobTicket();
```

**Optional: Set job name:**

If no job name is set, a generated job name is used.

```
$jobTicket->setJobName('Test-' . time());
```

**Set assembly line to use:**

```
$jobTicket->setAssemblyLineReference($assemblyLine);
```

**Optional: Set a job priority:**

If no priority is set, no priority is submitted to the Amendo server.

```
$jobTicket->setJobPriority(60);
```

**Optional: Add job properties to the job:**

```
$jobTicket->setStringProperty('Custom', 'AString', 'Text');
$jobTicket->setBooleanProperty('Custom', 'ABool', true);
$jobTicket->setIntegerProperty('Custom', 'AnInteger', 42);
$jobTicket->setFloatProperty('Custom', 'AFloat', 0.815);
```

The first argument of each method call specifies the list name to add the property to. The second argument secifies the property name and the third argument its value.

The first line adds a property of type string, the second line a property of type boolean, the third line a property of type integer and the fourth lie a property of type floating point to the job properties.

**Add one or more files to the job's run list:**

Use

```
$file = $jobTicket->addFile($filePath);
```

for regular local files or

```
$file = $jobTicket->addUri($filePath);
```

for file URI's or

```
$file = $jobTicket->addDownloadUri($filePath);
```

for download URI's.

**Optional: Add file properties to the added file:**

```
$file->setStringProperty('Custom', 'AString', 'FileText');
$file->setBooleanProperty('Custom', 'ABool', false);
$file->setIntegerProperty('Custom', 'AnInteger', 15);
$file->setFloatProperty('Custom', 'AFloat', 3.1415);
```

See job properties above for details.

**Submit the SimpleJobTicket to the Amendo server.**

```
$jobId = $amendoClient->startJobTicket($jobTicket);
```

On success a positive `$jobId` is returned by the Amendo server.
On error, either an exception is thrown or the Amendo server returns `0`.

**Optional: Querying the job overview:**

```
$result = $amendoClient->getJobOverview($jobId);
```

Returns an array whose contents depends on the current status of the job.

### Then run your copy

[](#then-run-your-copy)

```
$ docker run -it --rm --name amendo-client-example \
  --volume "$PWD":/usr/src/myapp --workdir /usr/src/myapp \
  php:8.5-cli php MyExample.php

```

Authors
-------

[](#authors)

- [Tim Strehle](https://github.com/tistre)

License
-------

[](#license)

This library is licensed under the MIT License - see the `LICENSE` file for details.

###  Health Score

48

—

FairBetter than 95% of packages

Maintenance73

Regular maintenance activity

Popularity18

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity78

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~168 days

Recently: every ~213 days

Total

12

Last Release

155d ago

Major Versions

v1.4.0 → v2.0.02023-08-14

PHP version history (8 changes)v1.0.0PHP ^7.4.0

v1.2.0PHP &gt;=7.4 &lt;8.1

v1.3.0PHP &gt;=7.4 &lt;8.2

v1.4.0PHP &gt;=7.4 &lt;8.3

v2.0.0PHP &gt;=8.1 &lt;8.3

v2.2.0PHP &gt;=8.2 &lt;8.4

v2.3.0PHP &gt;=8.2 &lt;8.5

v2.4.0PHP ^8.4

### Community

Maintainers

![](https://www.gravatar.com/avatar/605e43ba9b62f4099a39fc882cc25491b7c64267e657271094fe88759631f6f8?d=identicon)[tistre](/maintainers/tistre)

---

Top Contributors

[![tistre](https://avatars.githubusercontent.com/u/3024544?v=4)](https://github.com/tistre "tistre (35 commits)")

### Embed Badge

![Health badge](/badges/der-spiegel-amendo-client/health.svg)

```
[![Health](https://phpackages.com/badges/der-spiegel-amendo-client/health.svg)](https://phpackages.com/packages/der-spiegel-amendo-client)
```

###  Alternatives

[danog/madelineproto

Async PHP client API for the telegram MTProto protocol.

3.4k855.0k18](/packages/danog-madelineproto)[cloudinary/cloudinary_php

Cloudinary PHP SDK

39913.5M90](/packages/cloudinary-cloudinary-php)[opentok/opentok

OpenTok is a platform for creating real time streaming video applications, created by TokBox.

1413.0M10](/packages/opentok-opentok)[godruoyi/ocr

The Best Image Ocr SDK For BAT.

19314.7k1](/packages/godruoyi-ocr)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

245.2k](/packages/aedart-athenaeum)[daun/statamic-placeholders

Generate low-quality image placeholders for lazyloading Statamic assets

106.6k](/packages/daun-statamic-placeholders)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
