Image and PDF Compression PHP API
We are happy to introduce the first API for images and PDF online compression with unique features such as unlimited and free sub-accounts, 1 month of media backup and restoration. We would be happy to provide some help for your API integration and product promotion, create a free account and get in touch through our private ticket system.
Accounts
Accounts - Current account informations
/accounts/minePermission: need authentication through additional parameters
curl -X GET
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/accounts/mine'Url parameters
| Field | Type | Description |
|---|---|---|
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| quota_start | Date | First day of current month quota calculation |
| quota_end | Date | Last day of current month quota calculation |
| quota_current | Int | Current monthly consumption (in bytes) |
| quota_allowed | Int | Monthly allowed consumption (in bytes) |
| file_max_size | Int | Max file size allowed to uplooad (in bytes) |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Accounts - Current account informations
/accounts/minePermission: need authentication through additional parameters
curl -X GET
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/accounts/mine'Url parameters
| Field | Type | Description |
|---|---|---|
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| quota_start | Date | First day of current month quota calculation |
| quota_end | Date | Last day of current month quota calculation |
| quota_current | Int | Current monthly consumption (in bytes) |
| quota_allowed | Int | Monthly allowed consumption (in bytes) |
| file_max_size | Int | Max file size allowed to uplooad (in bytes) |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Accounts - Current account informations
/accounts/minePermission: need authentication through additional parameters
curl -X GET
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/accounts/mine'Url parameters
| Field | Type | Description |
|---|---|---|
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| quota_start | Date | First day of current month quota calculation |
| quota_end | Date | Last day of current month quota calculation |
| quota_current | Int | Current monthly consumption (in bytes) |
| quota_allowed | Int | Monthly allowed consumption (in bytes) |
| file_max_size | Int | Max file size allowed to uplooad (in bytes) |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Accounts - Current account consumption
/accounts/mine/consumptionPermission: need authentication through additional parameters
curl -X GET
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/accounts/mine/consumption'Url parameters
| Field | Type | Description |
|---|---|---|
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| consumption | Object | object |
| last_days | Object[] | Last 30 days of consumption |
| date | Object | Consumption date object |
| total_size_before | Object | Sum of bytes before optimization of all files sent this day |
| total_size_after | Object | Sum of bytes after optimization of all files sent this day |
| files_count | Object | Number of files optimized this day |
| last_months | Object[] | Last months of consumption |
| date | Object | Consumption date object |
| total_size_before | Object | Sum of bytes before optimization of all files sent this month |
| total_size_after | Object | Sum of bytes after optimization of all files sent this month |
| files_count | Object | Number of files optimized this day |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Accounts - Current account consumption
/accounts/mine/consumptionPermission: need authentication through additional parameters
curl -X GET
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/accounts/mine/consumption'Url parameters
| Field | Type | Description |
|---|---|---|
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| consumptions | Object[] | Consumption (Array of Objects) |
| date | Object | Consumption date object |
| date | Int | Consumption day |
| consumption | Int | Total consumption of the day |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Accounts - Subaccounts list
/accounts/sub/Permission: need authentication through additional parameters
curl -X GET
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/accounts/sub'Url parameters
| Field | Type | Description |
|---|---|---|
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| items | Objects[] | List of subaccounts (Array of Objects) |
| id | Int | Subaccount id |
| title | String | Subaccount title |
| description | String | Subaccount description |
| quota_start | Date | Subaccount first day of current month quota calculation |
| quota_end | Date | Subaccount last day of current month quota calculation |
| quota_allowed | String | Subaccount allowed monthly quota (in bytes) |
| quota_current | String | Subaccount current consumption (in bytes) |
| file_max_size | String | Subaccount allowed max files size allowed to upload (in bytes) |
| api_key | String | Subaccount api key |
| api_secret | String | Subaccount api secret |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Accounts - Subaccounts list
/accounts/sub/Permission: need authentication through additional parameters
curl -X GET
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/accounts/sub'Url parameters
| Field | Type | Description |
|---|---|---|
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| items | Objects[] | List of subaccounts (Array of Objects) |
| id | Int | Subaccount id |
| title | String | Subaccount title |
| description | String | Subaccount description |
| quota_start | Date | Subaccount first day of current month quota calculation |
| quota_end | Date | Subaccount last day of current month quota calculation |
| quota_allowed | String | Subaccount allowed monthly quota (in bytes) |
| quota_current | String | Subaccount current consumption (in bytes) |
| file_max_size | String | Subaccount allowed max files size allowed to upload (in bytes) |
| api_key | String | Subaccount api key |
| api_secret | String | Subaccount api secret |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Accounts - Subaccount informations
/accounts/sub/:idPermission: need authentication through additional parameters
curl -X GET
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/accounts/sub/123'Url parameters
| Field | Type | Description |
|---|---|---|
| id | Int | account id |
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| id | Int | Subaccount id |
| title | String | Subaccount title |
| description | String | Subaccount description |
| quota_start | Date | First day of current month quota calculation |
| quota_end | Date | Last day of current month quota calculation |
| quota_current | Int | Current monthly consumption (in bytes) |
| quota_allowed | Int | Monthly allowed consumption (in bytes) |
| quota_file_max_size | Int | Max file size allowed to upload (in bytes) |
| api_key | String | Subaccount api key |
| api_secret | String | Subaccount api secret |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Accounts - Subaccount informations
/accounts/sub/:idPermission: need authentication through additional parameters
curl -X GET
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/accounts/sub/123'Url parameters
| Field | Type | Description |
|---|---|---|
| id | Int | account id |
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| id | Int | Subaccount id |
| title | String | Subaccount title |
| description | String | Subaccount description |
| quota_start | Date | First day of current month quota calculation |
| quota_end | Date | Last day of current month quota calculation |
| quota_current | Int | Current monthly consumption (in bytes) |
| quota_allowed | Int | Monthly allowed consumption (in bytes) |
| quota_file_max_size | Int | Max file size allowed to upload (in bytes) |
| api_key | String | Subaccount api key |
| api_secret | String | Subaccount api secret |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Accounts - Create subaccount
/accounts/subPermission: need authentication through additional parameters
curl -X POST
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
-d 'title="New subaccount"'
-d 'description="This is my description"'
-d 'quota="524288000"'
'https://api.imagerecycle.com/v1/accounts/sub'Post parameters
| Field | Type | Description |
|---|---|---|
| title | String | Subaccount title |
| description | String | Subaccount description |
| quota | Int | Subaccount allowed monthly quota (in bytes) |
Url parameters
| Field | Type | Description |
|---|---|---|
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 201
| Field | Type | Description |
|---|---|---|
| id | Int | Subaccount id |
| title | String | Subaccount title |
| description | String | Subaccount description |
| quota_start | Date | First day of current month quota calculation |
| quota_end | Date | Last day of current month quota calculation |
| quota_current | Int | Current monthly consumption (in bytes) |
| quota_allowed | Int | Monthly allowed consumption (in bytes) |
| quota_file_max_size | Int | Max file size allowed to upload (in bytes) |
| api_key | String | Subaccount api key |
| api_secret | String | Subaccount api secret |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Accounts - Create subaccount
/accounts/subPermission: need authentication through additional parameters
curl -X POST
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
-d 'title="New subaccount"'
-d 'description="This is my description"'
-d 'monthly_quota="524288000"'
'https://api.imagerecycle.com/v1/accounts/sub'Post parameters
| Field | Type | Description |
|---|---|---|
| title | String | Subaccount title |
| description | String | Subaccount description |
| monthly_quota | Int | Subaccount allowed monthly quota (in bytes) |
Url parameters
| Field | Type | Description |
|---|---|---|
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 201
| Field | Type | Description |
|---|---|---|
| id | Int | Subaccount id |
| title | String | Subaccount title |
| description | String | Subaccount description |
| quota_start | Date | First day of current month quota calculation |
| quota_end | Date | Last day of current month quota calculation |
| quota_current | Int | Current monthly consumption (in bytes) |
| quota_allowed | Int | Monthly allowed consumption (in bytes) |
| quota_file_max_size | Int | Max file size allowed to upload (in bytes) |
| api_key | String | Subaccount api key |
| api_secret | String | Subaccount api secret |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Accounts - Delete subaccount
/accounts/sub/:idPermission: need authentication through additional parameters
curl -X DELETE
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/accounts/sub/123'Url parameters
| Field | Type | Description |
|---|---|---|
| id | Int | account id |
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| Success | Boolean |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Accounts - Delete subaccount
/accounts/sub/:idPermission: need authentication through additional parameters
curl -X DELETE
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/accounts/sub/123'Url parameters
| Field | Type | Description |
|---|---|---|
| id | Int | account id |
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| Success | Boolean |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Accounts - Edit subaccount fields
/accounts/sub/:idPermission: need authentication through additional parameters
curl -X PUT
-d 'title="My new title"'
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/accounts/sub/123'Url parameters
| Field | Type | Description |
|---|---|---|
| id | Int | account id |
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Post parameters
| Field | Type | Description |
|---|---|---|
| title | String | Subaccount title |
| description | String | Subaccount description |
| quota | Int | Subaccount allowed monthly quota (in bytes) |
Success 200
| Field | Type | Description |
|---|---|---|
| id | Int | Subaccount id |
| title | String | Subaccount title |
| description | String | Subaccount description |
| quota_start | Date | First day of current month quota calculation |
| quota_end | Date | Last day of current month quota calculation |
| quota_current | Int | Current monthly consumption (in bytes) |
| quota_allowed | Int | Monthly allowed consumption (in bytes) |
| quota_file_max_size | Int | Max file size allowed to upload (in bytes) |
| api_key | String | Subaccount api key |
| api_secret | String | Subaccount api secret |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Accounts - Edit subaccount fields
/accounts/sub/:idPermission: need authentication through additional parameters
curl -X PUT
-d 'title="My new title"'
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/accounts/sub/123'Url parameters
| Field | Type | Description |
|---|---|---|
| id | Int | account id |
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Post parameters
| Field | Type | Description |
|---|---|---|
| title | String | Subaccount title |
| description | String | Subaccount description |
| monthly_quota | Int | Subaccount allowed monthly quota (in bytes) |
Success 200
| Field | Type | Description |
|---|---|---|
| id | Int | Subaccount id |
| title | String | Subaccount title |
| description | String | Subaccount description |
| quota_start | Date | First day of current month quota calculation |
| quota_end | Date | Last day of current month quota calculation |
| quota_current | Int | Current monthly consumption (in bytes) |
| quota_allowed | Int | Monthly allowed consumption (in bytes) |
| quota_file_max_size | Int | Max file size allowed to upload (in bytes) |
| api_key | String | Subaccount api key |
| api_secret | String | Subaccount api secret |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Accounts - Reset subaccount API secret
/accounts/sub/reset_secret/:idPermission: need authentication through additional parameters
Url parameters
| Field | Type | Description |
|---|---|---|
| id | Int | account id |
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| id | Int | Subaccount id |
| title | String | Subaccount title |
| description | String | Subaccount description |
| quota_start | Date | First day of current month quota calculation |
| quota_end | Date | Last day of current month quota calculation |
| quota_current | Int | Current monthly consumption (in bytes) |
| quota_allowed | Int | Monthly allowed consumption (in bytes) |
| quota_file_max_size | Int | Max file size allowed to upload (in bytes) |
| api_key | String | Subaccount api key |
| api_secret | String | Subaccount api secret curl -X PUT -d 'auth={"key":"your_api_key","secret":"your_api_secret"}' 'https://api.imagerecycle.com/v1/accounts/sub/reset_secret/123' |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Accounts - Reset subaccount API secret
/accounts/sub/reset_secret/:idPermission: need authentication through additional parameters
Url parameters
| Field | Type | Description |
|---|---|---|
| id | Int | account id |
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| id | Int | Subaccount id |
| title | String | Subaccount title |
| description | String | Subaccount description |
| quota_start | Date | First day of current month quota calculation |
| quota_end | Date | Last day of current month quota calculation |
| quota_current | Int | Current monthly consumption (in bytes) |
| quota_allowed | Int | Monthly allowed consumption (in bytes) |
| quota_file_max_size | Int | Max file size allowed to upload (in bytes) |
| api_key | String | Subaccount api key |
| api_secret | String | Subaccount api secret curl -X PUT -d 'auth={"key":"your_api_key","secret":"your_api_secret"}' 'https://api.imagerecycle.com/v1/accounts/sub/reset_secret/123' |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Accounts - Reset subaccount consummate quota
/accounts/sub/reset_quota/:idPermission: need authentication through additional parameters
Url parameters
| Field | Type | Description |
|---|---|---|
| id | Int | account id |
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| id | Int | Subaccount id |
| title | String | Subaccount title |
| description | String | Subaccount description |
| quota_start | Date | First day of current month quota calculation |
| quota_end | Date | Last day of current month quota calculation |
| quota_current | Int | Current monthly consumption (in bytes) |
| quota_allowed | Int | Monthly allowed consumption (in bytes) |
| quota_file_max_size | Int | Max file size allowed to upload (in bytes) |
| api_key | String | Subaccount api key |
| api_secret | String | Subaccount api secret curl -X PUT -d 'auth={"key":"your_api_key","secret":"your_api_secret"}' 'https://api.imagerecycle.com/v1/accounts/sub/reset_quota/123' |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Images
Images - Get images list
/imagesPermission: logged account
curl -X GET
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/images'Url parameters
| Field | Type | Description |
|---|---|---|
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| items | Objects[] | List of images (Array of Objects) |
| id | Int | Image id |
| filename | String | Image filename |
| width | Int | Image width |
| height | Int | Image height |
| size_before | Int | Image size before compression |
| size_after | Int | Image size after compression |
| saved | Float | Image saved proportion |
| time | Date | Image creation date |
| origin_url | String | {String} Image original download link |
| optimized_url | String | {String} Image optimized download link |
| expiration_date | Date | {String} Image expiration date |
| total | Int | Total number of items |
| prev | Object | Previous pagination object |
| link | String | Previous pagination link API address |
| offset | Int | Previous pagination offset |
| limit | Int | Previous pagination limit |
| next | Object | Next pagination object |
| link | String | Next pagination link API address |
| offset | Int | Next pagination offset |
| limit | Int | Next pagination limit |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Images - Get images list
/imagesPermission: logged account
curl -X GET
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/images'Url parameters
| Field | Type | Description |
|---|---|---|
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| items | Objects[] | List of images (Array of Objects) |
| id | Int | Image id |
| filename | String | Image filename |
| width | Int | Image width |
| height | Int | Image height |
| size_before | Int | Image size before compression |
| size_after | Int | Image size after compression |
| saved | Float | Image saved proportion |
| time | Date | Image creation date |
| origin_url | String | {String} Image original download link |
| optimized_url | String | {String} Image optimized download link |
| expiration_date | Date | {String} Image expiration date |
| total | Int | Total number of items |
| prev | Object | Previous pagination object |
| link | String | Previous pagination link API address |
| offset | Int | Previous pagination offset |
| limit | Int | Previous pagination limit |
| next | Object | Next pagination object |
| link | String | Next pagination link API address |
| offset | Int | Next pagination offset |
| limit | Int | Next pagination limit |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Images - Get an image
/images/:idPermission: need authentication through additional parameters
curl -X GET
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/images/3012'Parameter
| Field | Type | Description |
|---|---|---|
| id | Int | Image id |
Url parameters
| Field | Type | Description |
|---|---|---|
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| id | Int | Image id |
| filename | String | Image filename |
| width | Int | Image width |
| height | Int | Image height |
| size_before | Int | Image size before compression |
| size_after | Int | Image size after compression |
| saved | Float | Image saved proportion |
| time | Date | Image creation date |
| origin_url | String | {String} Image original download link |
| optimized_url | String | {String} Image optimized download link |
| expiration_date | Date | {String} Image expiration date |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Images - Get an image
/images/:idPermission: need authentication through additional parameters
curl -X GET
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/images/3012'Parameter
| Field | Type | Description |
|---|---|---|
| id | Int | Image id |
Url parameters
| Field | Type | Description |
|---|---|---|
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 200
| Field | Type | Description |
|---|---|---|
| id | Int | Image id |
| filename | String | Image filename |
| width | Int | Image width |
| height | Int | Image height |
| size_before | Int | Image size before compression |
| size_after | Int | Image size after compression |
| saved | Float | Image saved proportion |
| time | Date | Image creation date |
| origin_url | String | {String} Image original download link |
| optimized_url | String | {String} Image optimized download link |
| expiration_date | Date | {String} Image expiration date |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Images - Add a new image
/imagesPermission: need authentication through additional parameters
curl -X POST
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
-d 'url=https://www.google.fr/images/srpr/logo11w.png'
-d 'params={"compression_type":"lossy"}'
'https://api.imagerecycle.com/v1/images'Post parameters
| Field | Type | Description |
|---|---|---|
| file optional | File | File to send |
| url optional | String | an URL where download the file |
Url parameters
| Field | Type | Description |
|---|---|---|
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 201
| Field | Type | Description |
|---|---|---|
| id | Int | Image id |
| filename | String | Image filename |
| width | Int | Image width |
| height | Int | Image height |
| size_before | Int | Image size before compression |
| size_after | Int | Image size after compression |
| saved | Float | Image saved proportion |
| time | Date | Image creation date |
| origin_url | String | {String} Image original download link |
| optimized_url | String | {String} Image optimized download link |
| expiration_date | Date | {String} Image expiration date |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 403 Forbidden
| Field | Type | Description |
|---|---|---|
| errCode | Int | 403 Forbidden |
| errMessage | String | Error message |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Images - Add a new image
/imagesPermission: need authentication through additional parameters
curl -X POST
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
-d 'url=https://www.google.fr/images/srpr/logo11w.png'
-d 'params={"compression_type":"lossy"}'
'https://api.imagerecycle.com/v1/images'Post parameters
| Field | Type | Description |
|---|---|---|
| file optional | File | File to send |
| url optional | String | an URL where download the file |
Url parameters
| Field | Type | Description |
|---|---|---|
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 201
| Field | Type | Description |
|---|---|---|
| id | Int | Image id |
| filename | String | Image filename |
| width | Int | Image width |
| height | Int | Image height |
| size_before | Int | Image size before compression |
| size_after | Int | Image size after compression |
| saved | Float | Image saved proportion |
| time | Date | Image creation date |
| origin_url | String | {String} Image original download link |
| optimized_url | String | {String} Image optimized download link |
| expiration_date | Date | {String} Image expiration date |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 403 Forbidden
| Field | Type | Description |
|---|---|---|
| errCode | Int | 403 Forbidden |
| errMessage | String | Error message |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Images - Delete an image
/images/:idPermission: need authentication through additional parameters
curl -X DELETE
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'http://imageoptimizerapi.local/v1/images/23189'Url parameters
| Field | Type | Description |
|---|---|---|
| id | Int | Image id |
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 204
| Field | Type | Description |
|---|---|---|
| Success | Object |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Images - Delete an image
/images/:idPermission: need authentication through additional parameters
curl -X DELETE
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'http://imageoptimizerapi.local/v1/images/23189'Url parameters
| Field | Type | Description |
|---|---|---|
| id | Int | Image id |
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 204
| Field | Type | Description |
|---|---|---|
| Success | Object |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Images - Delete all images
/images/allPermission: need authentication through additional parameters
curl -X DELETE
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/images'Url parameters
| Field | Type | Description |
|---|---|---|
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 204
| Field | Type | Description |
|---|---|---|
| Success | Object |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Images - Delete all images
/images/allPermission: need authentication through additional parameters
curl -X DELETE
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/images'Url parameters
| Field | Type | Description |
|---|---|---|
| auth | json | Authentication Object |
| key | String | Authentication key |
| secret | String | Authentication secret |
Success 204
| Field | Type | Description |
|---|---|---|
| Success | Object |
Error 400 Bad Request
| Field | Type | Description |
|---|---|---|
| errCode | Int | The 400 http error code |
| errMessage | String | Query error |
Error 401 Unauthorized
| Field | Type | Description |
|---|---|---|
| errCode | Int | The http error code |
| errMessage | String | The last error message |
Images - Download a file
/images/:type/:token/:namePermission: no permission required
curl -X GET
'https://api.imagerecycle.com/v1/images/optimized/cd493caac5e70f154c80141fccb5ad0a/logo11w.png'Parameter
| Field | Type | Description |
|---|---|---|
| type | String | Image type Allowed values: |
| token | String | Image token Size range: |
| name | String | Image name |
Success 200
| Field | Description |
|---|---|
| Return | a file |
Error 404 Not found
| Field | Description |
|---|---|
| ErrCode | 404 |
| ErrMessage | Not found |
Images - Download a file
/images/:type/:token/:namePermission: no permission required
curl -X GET
'https://api.imagerecycle.com/v1/images/optimized/cd493caac5e70f154c80141fccb5ad0a/logo11w.png'Parameter
| Field | Type | Description |
|---|---|---|
| type | String | Image type Allowed values: |
| token | String | Image token Size range: |
| name | String | Image name |
Success 200
| Field | Description |
|---|---|
| Return | a file |
Error 404 Not found
| Field | Description |
|---|---|
| ErrCode | 404 |
| ErrMessage | Not found |
Images - Download a zip file
/images/zip/:type/:idsPermission: no permission required
curl -X GET
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/images/zip/optimized/1230,1231,1400'Url parameters
| Field | Type | Description |
|---|---|---|
| type | String | Image type Allowed values: |
| ids | String | list of comma separated ids to download |
Success 200
| Field | Description |
|---|---|
| Return | a zip file |
Error 404 Not found
| Field | Description |
|---|---|
| ErrCode | 404 |
| ErrMessage | Not found |
Images - Download a zip file
/images/zip/:type/:idsPermission: no permission required
curl -X GET
-d 'auth={"key":"your_api_key","secret":"your_api_secret"}'
'https://api.imagerecycle.com/v1/images/zip/optimized/1230,1231,1400'Url parameters
| Field | Type | Description |
|---|---|---|
| type | String | Image type Allowed values: |
| ids | String | list of comma separated ids to download |
Success 200
| Field | Description |
|---|---|
| Return | a zip file |
Error 404 Not found
| Field | Description |
|---|---|
| ErrCode | 404 |
| ErrMessage | Not found |
We can help with image and PDF compression API
We have a private support ticket system with a dedicated developer that know very well the image compression because he created it. Register a free account and drop us a ticket in the API section. We can provide an account with quota for your testing purpose. API integration in new CMS or new extension for CMS are welcome as well as custom projects integrations. Note that we already have a PHP script that can be downloaded and used with our image and PDF compression API.
Compress API Update and Integration
We are proud that you choose and take time to integrate our extension/service with our API, so we can help with promotion too! by promotion we mean on our official blog, social networks and 3rd party reviews. The API is often updated depending mainly of new image format or customer needs, but we always keep in mind that an API is here to stay, so we make sure of our API code legacy.
