Skip to main content

Setup ImageSwift Add-on on CS-Cart

Step 1: Manual Installation of the Add-on​

To install the ImageSwift add-on manually in CS-Cart, follow these steps:

  1. Log in to your CS-Cart admin panel.

  2. Go to Add-ons > Manage add-ons.

  3. Click the + (Upload & install add-on) button in the top right corner.

  4. Choose the installation method:

    • Upload the .zip file of the add-on you received.
    • Click Upload & Install.

  5. After installation, make sure the add-on is activated.

  6. Go to the Image Swift add-on settings to configure it based on your store’s requirements.

API image

ImageSwift Add-on — General Setup​

The General Setup tab allows you to connect your store with the Lutastore Cloud service, which helps in optimizing, compressing, and delivering images efficiently via CDN for faster page loading.

Required API Credentials​

To configure this section, you must first subscribe to the Lutastore Cloud service in order to generate the required API credentials:

  • API Endpoint
  • API Key
    • You will receive this after subscribing to Lutastore. It’s used to authenticate your integration.
  • API Secret
    • A private key that works with the API Key to secure communication between your store and the Lutastore cloud.
API image

How to Generate a New API Key​

To generate a new API key and secret:

  1. Log in to your Lutastore account.
  2. Navigate to API Keys > Generate New Key.
  3. While generating the key, make sure to select the following permissions:
    • Service Status
    • AI Sizes Recommendations
  4. Once the key is generated, copy the:
    • API Endpoint
    • API Key
    • API Secret
  5. Paste them into the fields in the General Setup tab of the add-on in your CS-Cart admin panel.
API image

Note: You must complete your Lutastore subscription first to generate your API credentials. These keys are mandatory for the integration to work properly.

ImageSwift Add-on — ImageSwift (CDN)​

To activate the ImageSwift CDN service on your store, you need to provide two essential fields:

  • Storage ID
  • Image Source Key

These values are required to link your store with the ImageSwift cloud service and enable optimized image delivery via CDN.

API image

Required Fields​

  • Storage ID This identifies your storage space on the ImageSwift cloud. It is usually the same as your domain name but can sometimes be different.
  • Image Source Key This key defines the source of your store’s images (origin). It tells ImageSwift where to pull the original images from.

Cache Version The Cache Version is an optional numeric field used to clear the image cache. When you update this value, ImageSwift regenerates image URLs with a new version, forcing the browser to reload fresh images.

Default: Empty (no versioning applied)

How to Get Your Storage ID & Source Key​

  1. Get Storage ID
    • Go to: Service Setup > ImageSwift > Settings
    • Copy the Storage ID (typically matches your domain, but double-check as it may differ).
API image

Note: In Service Setup > Settings, the option “Optimize Quality To” should be set to 65% the first time you configure it — and it should not be changed later. This value ensures a balance between image quality and performance.

  1. Get Image Source Key

    • Go to: Service Setup > ImageSwift > Image Sources
    • The Image Source Key defines where your original images are hosted (your server or a third-party CDN).
API image

Creating a Public Web Folder​

While adding a new image source, you’ll create a public web folder that includes:

  • Source Title: Any descriptive name.
  • URL Path: This should be the full path up to the images folder.

Note: If your site structure includes a fixed folder before the images folder, make sure the path includes that folder as well.

Image Source Order Matters

The order of sources matters — the system checks sources in order. Make sure the correct source is placed at the top for consistent image loading.

AI Sizes Recommendations Tab​

This section allows you to automate image size optimization using AI-powered tools provided by the Image Swift service.

Sending Type​

You have two options for how image size optimization requests are sent:

  • Direct Automation Optimization requests are sent instantly as images are uploaded or updated. (Can increase server load with frequent image changes.)
  • Background Mode (Recommended) Requests are sent in bulk at regular intervals using a cron job. This method significantly reduces the number of requests and improves performance.
API image

Recommendation: Use Background Mode for better efficiency and scalability.

Cron Jobs for Background Mode​

To enable Background Mode, you must set up one of the following cron jobs (listed below the option in the admin panel). These scheduled tasks automate the image optimization process in the background.

Plan Requirement

To use the AI Sizes Recommendations feature, your account must be on the Basic plan or higher.