API. URL-based integration
To make integration easier we provide a lightweight API that you can directly use from HTML code.
URL pattern for API call
All endpoints follow the same pattern
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] | Operation parameters for a function call you are using |
[API_KEY] | A unique API key |
Example using <img> tag
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 <picture> tag
Before:
After:
We support all transformation required for the typical website.
Read more on operations:
You can explore API sandbox here: https://pixboost.com/docs/api/
Last updated