Using Pixboost, you can set up a private S3 bucket to be a source of your images. Here, we will go through requirements for the S3 bucket, how to add an integration to Pixboost and how to optimise images from the bucket using API.

AWS setup

We assume that you already have S3 bucket with your images stored there. If not then you can read how to do that here.

To setup a new user that you'll integrate with Pixboost:

• Create a new IAM user​

• ​Add new credentials for the user.

• ​Update or create bucket policy and give the user s3:ListBucket and s3:GetObject permissions.

Below is an example of a bucket policy:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Principal": {
                "AWS": "arn:aws:iam::<ACCOUNT_ID>:user/<USER_ID>"
            },
            "Action": "s3:ListBucket",
            "Resource": "arn:aws:s3:::<BUCKET_NAME>"
        },
        {
            "Effect": "Allow",
            "Principal": {
                "AWS": "arn:aws:iam::<ACCOUNT_ID>:user/<USER_ID>"
            },
            "Action": "s3:GetObject",
            "Resource": "arn:aws:s3:::<BUCKET_NAME>/*"
        }
    ]
}

Pixboost setup

To set up the integration:

• ​Login to your Pixboost account.

• Click on "Add source" link under the "Images Sources" panel

• In the appeared form set Type to "Amazon AWS S3 Bucket" and fill in the details

  • Alias is a unique identifier of the images source that will be used in the URL when calling API

  • Bucket name is the name of a bucket

  • Region is an AWS region ID of the bucket

  • Path Prefix is an optional prefix that will be used for all requests. It could be used if all your images in

    the bucket stored in one folder. In that case, you could set "Path prefix", and you won't need to add it to each API call.

  • Access Key is an AWS IAM user's access key created in the step above

  • Secret Key is an AWS IAM user's secret key created in the step above

• Click on "Add" button and verify that the source has been created

Using API

All API requests follow the original pattern:

https://pixboost.com/api/2/img/[ALIAS]/[PATH_TO_THE_IMAGE]/[OPERATION]?[OPERATION_PARAMS]&auth=[API_KEY]

Let's consider a configuration from the step above. For instance, if there is an image in S3 bucket with a path (key): prefix/another-prefix/images/hello.png then to resize it we use the following API call:

https://pixboost.com/api/2/img/bucket/images/hello.png/resize?size=200&auth=[API_KEY]

In the example above /bucket (after /api/2/img) will be replaced with bucket name and path prefix - pixboost-test-source/prefix/another-prefix

Limitations

You could have a maximum of 10 images sources. That is a soft limit, so if you'd like to raise it, please email us at [email protected]