API. URL-based integration

Pixboost

Home

Search…

Overview

Quick Start (10 minutes or less)

Tools and Setup

API. URL-based integration

JavaScript Integration

API. URL-based integration

To make integration easier we came up with URL-based integration. Which means all you need to do is to setup image URL for tags <img> and <picture> to start using Pixboost.
URL pattern for API call
https://pixboost.com/api/2/img/[IMAGE_URL|IMAGES_SOURCE_ALIAS_WITH_PATH]/[OPERATION]?[OPERATION_PARAMS]&auth=[API_KEY]
Item
Description
[IMAGE_URL]
The URL of the original image you would like to process through Pixboost.
[IMAGES_SOURCE_ALIAS_WITH_PATH]
An alias of an images source with relative path to the image.
[OPERATION]
Pixboost function call
[OPERATION_PARAMS]
Pixboost parameters for a function call you are using
[API_KEY]
A unique key created by Pixboost for security purposes
Example using tag <img>
Before:
<img src="http://www.midday.coffee/assets/cup.jpeg" alt="Midday Coffee">
After:
<img src="http://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/resize?size=200x100&auth=MTg4MjMxMzM3MA__" alt="Midday Coffee">
Example using tag <picture>
Before:
<picture>
    <source srcset="http://www.midday.coffee/assets/cup.jpeg" 
        media="(min-width: 769px)">
    <source srcset="http://www.midday.coffee/assets/cup.jpeg" 
        media="(max-width: 768px)">
    <source srcset="http://www.midday.coffee/assets/cup.jpeg" 
        media="(max-width: 576px)">
    <img src="http://www.midday.coffee/assets/cup.jpeg">
</picture>
After:
<picture>
    <source srcset="https://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/optimise?auth=API_KEY" 
        media="(min-width: 769px)">
    <source srcset="https://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/resize?size=300&auth=API_KEY" 
        media="(max-width: 768px)">
    <source srcset="https://pixboost.com/api/2/img/http://www.midday.coffee/assets/cup.jpeg/fit?size=100x100&auth=API_KEY" 
        media="(max-width: 576px)">
    <img src="http://www.midday.coffee/assets/cup.jpeg">
</picture>
We support main resizing transformations that you would need for your website.
Read more on operations:
​Resize​
​Fit​
​Optimise​
​As is​
You can explore API sandbox here: https://pixboost.com/docs/api/​