About the Akeneo category

Roland · September 21, 2022, 9:57am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: REST API reference

Connector package documentation

1. Setting up HTTP Client Akeneo

1.1 Steps

In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Akeneo HTTP Client as the prototype of the HTTP Client.
Fill in the Base URI,Client ID, Client Secret, Username, Password, and Authentication Method
Note : We recommend to use Body as Authentication Method.
Press “Grant Access to Akeneo”.
The Key will show up and you can save the Client for use.

2. Subscribing to Entities from Akeneo

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select Akeneo Subscriber as the subscriber.
Select the entity you want to subscribe from Akeneo.
Add any request parameters needed to subscribe to the entity (optional).
You can optionally add a transformer to transform the request parameters into something you need.
Select the Akeneo HTTP Client to use
You can add a pagination feature to allow Alumio to fetch a paginated entity.

2.2 General Concept

We follow Akeneo documentation on building this connector, so you can easily use the connector based on Akeneo API Reference.

Entity

It’s the entity you want to subscribe from Akeneo. Please refer to the entities in Management APIs from Akeneo API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on Akeneo API Reference. Please look at the example below on how to fill the Request Parameters field when subscribing “All Parcels” entity

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0

That’s why we need to define the code property inside the path property in the Request Parameters field. The properties inside query parameters will be parsed as query parameters. The final URL will be like this /api/rest/v1/products/123

Input Transformer

Any transformer’s set here will be executed after the Request Parameters loaded. So, you basically can add any transformer to provide and transform the request parameters into anything you need, either as path parameters and/or as query parameters of an entity.

HTTP Client

It’s the HTTP Client configuration or prototype you will use to access Akeneo.

3. Publishing entity to Akeneo

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select Akeneo Publisher as the publisher.
Select the action that you want the publisher to do with the data.
Select the Akeneo entity you want the data to be published to.
You can optionally add any query parameters to the request.
You can also optionally add any transformers to transform the data into anything you need before submitting it to Akeneo.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Action

Currently we support Create (HTTP POST method), Update (HTTP PUT method), and Delete (HTTP DELETE method).

Entity

We support publishing to most Akeneo endpoints, but not with publishing binary files for now. Please refer to the entities in Management APIs from Akeneo API Reference page. Based on the documentation, some endpoints may need one or more path parameters.

For endpoints that require object as the request payload, please look at the example below. For example, we want to delete a Product. Please select “Delete” as the action and “Assets” as the entity of the publisher.

As you can see, we need to add code in the Path, so please make sure we add the code inside the key path in the data. For example

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.

Alumio will send an API request to Akeneo with URL /api/rest/v1/products/123