PHPackages                             ingowalther/image-minify-api - 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 & Media](/categories/media)
4. /
5. ingowalther/image-minify-api

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

ingowalther/image-minify-api
============================

0.0.3(10y ago)26563[2 issues](https://github.com/ingowalther/image-minify-api/issues)[2 PRs](https://github.com/ingowalther/image-minify-api/pulls)MITPHP

Since Nov 4Pushed 9y ago4 watchersCompare

[ Source](https://github.com/ingowalther/image-minify-api)[ Packagist](https://packagist.org/packages/ingowalther/image-minify-api)[ Docs](https://github.com/ingowalther/image-minify-api)[ RSS](/packages/ingowalther-image-minify-api/feed)WikiDiscussions master Synced 4w ago

READMEChangelogDependencies (8)Versions (5)Used By (0)

Image Minify API
================

[](#image-minify-api)

Install an Image-Compression-Service (like TinyPng, JPEGMini) on your own Server!

[![Build Status](https://camo.githubusercontent.com/6fa14205300240eaaec56398d3bdaffff170d5e21ab5ae196545d239c5a6c9d5/68747470733a2f2f7472617669732d63692e6f72672f696e676f77616c746865722f696d6167652d6d696e6966792d6170692e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/ingowalther/image-minify-api)

- [Image Minify API](#)
    - [Installation](#installation)
        - [Create Database](#create-database)
        - [Install Project](#install-project)
        - [Set permissions for files](#set-permissions-for-files)
        - [Setup Webserver](#setup-webserver)
    - [Usage](#usage)
        - [Create API-Key](#create-api-key)
        - [Compress an Image](#compress-an-image)
            - [Response](#response)
        - [List all user](#list-all-user)
    - [Clients](#api-clients)
        - [PHP](#api-clients)
        - [Grunt-Task](#api-clients)
    - [TODO](#todo)

Currently supports:

- jpeg (mozJpeg, Installation Instructions: )
- png (pngquant, )
- svg (SVGO, )
- gif (Gifsicle, )

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

[](#installation)

### Create Database

[](#create-database)

You should create a database first. In this database Image Minify API will create all necessary tables during composer install.

### Install Project

[](#install-project)

```
composer create-project ingowalther/image-minify-api %installation-folder-name%
```

### Set permissions for files

[](#set-permissions-for-files)

```
chmod a+rw log
```

### Setup Webserver

[](#setup-webserver)

```
vHost DocRoot -> web/

```

Usage
-----

[](#usage)

### Create API-Key

[](#create-api-key)

```
 bin/console user:add
```

Enter a Username. If the user is created correctly you will see the API-Key in your Terminal.

### Compress an Image

[](#compress-an-image)

POST with Params "api\_key" and File with Name "image" to

Example:

```
curl --form "image=@test.jpg" --form api_key=VVDFNNflLIQdCH5vnx0RkmCxxjhHIL6  http://localhost/minify > result.json
```

#### Response

[](#response)

You will get a Json-Response like this:

```
{
   "success":true,
   "oldSize":539,
   "newSize":394,
   "saving": 26,
   "image":"\/9j\/4AAQSkZJRgABAQAAAQABAAD\/\/gATQ3JlYXRlZCB3aXRoIEdJTVD\/2wCEAAoKCgoKCgsMDAsPEA4QDxYUExMUFiIYGhgaGCIzICUgICUgMy03LCksNy1RQDg4QFFeT0pPXnFlZXGPiI+7u\/sBCgoKCgoKCwwMCw8QDhAPFhQTExQWIhgaGBoYIjMgJSAgJSAzLTcsKSw3LVFAODhAUV5PSk9ecWVlcY+Ij7u7+\/\/CABEIAAEAAQMBIgACEQEDEQH\/xAAUAAEAAAAAAAAAAAAAAAAAAAAH\/9oACAEBAAAAAGb\/xAAUAQEAAAAAAAAAAAAAAAAAAAAA\/9oACAECEAAAAH\/\/xAAUAQEAAAAAAAAAAAAAAAAAAAAA\/9oACAEDEAAAAH\/\/xAAUEAEAAAAAAAAAAAAAAAAAAAAA\/9oACAEBAAE\/AH\/\/xAAUEQEAAAAAAAAAAAAAAAAAAAAA\/9oACAECAQE\/AH\/\/xAAUEQEAAAAAAAAAAAAAAAAAAAAA\/9oACAEDAQE\/AH\/\/2Q=="
}
```

ParameterDescriptionsuccesstrue or falseoldSizeImageSize before compressing (in Byte)newSizeImageSize after compressing (in Byte)savingThe saving of bytes in percentimageThe binarydata of the compressed image (base64 encoded)### List all user

[](#list-all-user)

```
 bin/console user:list
```

Output:

[![Console output](https://camo.githubusercontent.com/1e85cc6e3f4c5e9646017ceee058e5c6df069b2210f4a60c9a141957f863aa1e/687474703a2f2f692e696d6775722e636f6d2f36534b634263462e706e67)](https://camo.githubusercontent.com/1e85cc6e3f4c5e9646017ceee058e5c6df069b2210f4a60c9a141957f863aa1e/687474703a2f2f692e696d6775722e636f6d2f36534b634263462e706e67)

API-Clients
-----------

[](#api-clients)

PHP:

Grunt-Task:

TODO
----

[](#todo)

- Quota

###  Health Score

29

—

LowBetter than 57% of packages

Maintenance18

Infrequent updates — may be unmaintained

Popularity19

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 95.5% 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 ~0 days

Total

3

Last Release

3889d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/12ad49d695476c7e97f63c6ba0896a60ede92d57a3cdfc5674a91723b702b785?d=identicon)[ingowalther](/maintainers/ingowalther)

---

Top Contributors

[![ingowalther](https://avatars.githubusercontent.com/u/7096553?v=4)](https://github.com/ingowalther "ingowalther (64 commits)")[![luchianenco](https://avatars.githubusercontent.com/u/3841383?v=4)](https://github.com/luchianenco "luchianenco (2 commits)")[![burki](https://avatars.githubusercontent.com/u/464455?v=4)](https://github.com/burki "burki (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/ingowalther-image-minify-api/health.svg)

```
[![Health](https://phpackages.com/badges/ingowalther-image-minify-api/health.svg)](https://phpackages.com/packages/ingowalther-image-minify-api)
```

###  Alternatives

[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.4M196](/packages/sulu-sulu)[2lenet/crudit-bundle

The easy like Crud'it Bundle.

1615.6k12](/packages/2lenet-crudit-bundle)[open-dxp/opendxp

Content & Product Management Framework (CMS/PIM)

9417.2k55](/packages/open-dxp-opendxp)

PHPackages © 2026

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