Skip to content
This repository has been archived by the owner on Jul 3, 2024. It is now read-only.

Latest commit

 

History

History
104 lines (70 loc) · 7.16 KB

akeneo.md

File metadata and controls

104 lines (70 loc) · 7.16 KB

Akeneo PIM

Akeneo is a popular PIM used by several organizations to store, manage and enrich the information about their products.

With this integration between ImageKit and Akeneo, you can access the images, and other non-media files (PDFs, docs, etc.) stored in your PIM and deliver optimized and transformed versions of them in real-time.

ImageKit supports three kinds of media files from Akeneo.

  1. Product Media Files
  2. Asset Media Files
  3. Reference Entities Media Files

{% hint style="info" %} ImageKit does not copy files from your PIM to its Media Library. Like all other external storage integrations, this integration accesses Akeneo on-demand when you request a file through ImageKit, and the file is unavailable in the cache. {% endhint %}

Step 1: Create a connection in Akeneo

We need to create a connection in Akeneo that will give us values for client ID, secret, username and password. These values will then be used to connect Akeneo to ImageKit. You can find the latest instructions for creating a connection in different versions of Akeneo on their official documentation.

  1. The flow type will be "Destination connection" flow (data is flowing out of Akeneo).
  2. Ensure that you set the appropriate permissions for this connection as defined here. ImageKit only needs access to be able to get your media files, and to generate the necessary authentication token for the same.

Once the connection is created, you can copy the credentials generated. The password is only shown once to you after the connection creation. So, make sure you save it somewhere.

Step 2: Adding Akeneo External Storage to ImageKit

Use the credentials generated in step 1 to add an external storage of type "Akeneo PIM" in the ImageKit dashboard.

  1. Go to the external storage section in your ImageKit.io dashboard, and under the Origins section, click on the "Add origin" button.
  2. Choose Akeneo PIM from the origin type dropdown.
  3. Give your origin a name, it will appear in the list of origins you have added. For example - My Akeneo PIM.
  4. Provide the Base URL or the endpoint of the Akeneo PIM instance you want to access. Add the other credential values in the corresponding fields.
  5. Leave the advanced options as it is for now.
  6. Click on the Submit button.

Step 3: Access the image through ImageKit.io URL-endpoint

When you add your first origin in the dashboard, the origin is by default made accessible through the default URL-endpoint of your ImageKit.io account. For subsequent origins, you can either create a separate URL-endpoint or edit the existing URL-endpoint (including default) and make this newly added origin accessible by editing the origin preference list.

Every media file in Akeneo has a data or a code value that looks like this f/d/1/d/fd1d_myimagefilename.png. To access a file, you need to create a URL using this data or code value, along with the media file type (media-file, asset-media-file, or reference-entities-media-file) and the URL endpoint. For example, for the above code, you can access the file as shown below.

For any of the three media types above, you can transform them by adding the transformation string like you would usually do for any other image origin.

{% tabs %} {% tab title="URL structure" %}

            URL-endpoint                transformation  media type     data or code                                    
┌─────────────────────────────────────┐┌─────────────┐┌───────────┐┌───────────────────┐
https://ik.imagekit.io/your_imagekit_id/tr:w-300,h-300/media-files/rest-of-the-path.jpg

{% endtab %} {% endtabs %}

If you get a "Not found" error while accessing the image, check out this troubleshooting guide.

{% hint style="info" %} :man_mage:Tips: You can also use a custom domain like images.example.com. {% endhint %}

Step 3: Integrate and Go live

Now start using ImageKit.io URL endpoint in your application to accelerate image loading.

Get started with our quick start guides and SDKs:

{% content-ref url="../../getting-started/quickstart-guides/" %} quickstart-guides {% endcontent-ref %}

{% content-ref url="../../api-reference/api-introduction/sdk.md" %} sdk.md {% endcontent-ref %}

Learn about real-time image resizing:

{% content-ref url="../../features/image-transformations/" %} image-transformations {% endcontent-ref %}

Advanced options for Akeneo PIM origin

Include canonical response header

When enabled, the image response contains a Link header with the appropriate URL and rel=canonical. You will have to specify the base URL for the canonical header.

For example, if you set https://www.example.com as the base URL for canonical header, then the image response for URL https://ik.imagekit.io/your_imagekit_id/rest-of-the-path.jpg will have a Link header like this:

Link: <https://www.example.com/rest-of-the-path.jpg>; rel="canonical"