About the Ibexa category

anon99371720 · September 21, 2022, 9:58am

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

Extra information

System documentation: Ibexa API Reference

Connector package documentation

1. Setting up the HTTP Client Ibexa

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select Ibexa Client as the HTTP Client.
Select the JWT Token Authentication to use
Fill in the Base URL, Username, and Password according to your Ibexa account.
(For more information, see Ibexa JWT Token Reference)
You can optionally enable the logging of request to get the log of the authentication.
Save the HTTP Client for use.

2. Subscribing to Entities from Ibexa

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select Ibexa Subscriber as the subscriber.
Select the entity you want to subscribe to from Ibexa.
Add any request parameters needed to subscribe to the entity.
You can optionally add a transformer to transform the request parameters into something you will request from Ibexa.
Select the Ibexa HTTP Client to use.
You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

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

Entity

The entity you want to subscribe to Ibexa. Please refer to the entities from Ibexa API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the Ibexa API Reference

Please look at the example below on how to fill Request Parameters field when subscribing “Load Content” entity.

We can see in the documentation that the end point requires “contentId” as a path parameter to define which content we want to fetch.

We set the “contentId” by providing it inside the path key in the Request Parameters,

“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

Alumio will send the request as /content/objects/123

Input Transformer

Any transformers set here will be executed before the Request Parameters are loaded. So, you can add any transformer to provide and manipulate the request parameters into anything you need, either as path parameters and/or as query parameters of an entity.

HTTP Client

The HTTP Client configuration you will use to access Ibexa.

3. Publishing Entity to Ibexa

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select Ibexa Publisher as the publisher.
Select the action that you want the publisher to perform with the data.
Select the Ibexa entity you want the data to be published to.
You can optionally add any path data to the request on the key path.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
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), Head (HTTP HEAD method), Delete (HTTP DELETE method), Copy (HTTP COPY method), Publish (HTTP PUBLISH method), Move (HTTP MOVE method), Swap (HTTP SWAP method), and Patch (HTTP PATCH method) on submitting data to Ibexa.

Entity

We support publishing to most Ibexa endpoints.
Please refer to Ibexa API Reference page.

Based on the documentation, some endpoints may need one or more path parameters.
For example, we want to use “Delete Product”.

Please select “Delete” as the action and “Delete Product” as the entity of the publisher.

The documentation says that we need “identifier” as path parameters. In that case, you need to provide “identifier” data into the path key in the data, either as an output from Routes or output from Transformers in Outgoing Configuration. And you can put the data you want to send to Ibexa into the payload key in the data.

“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 then send the request as /product/catalog/products/123
Examples of the Possible Response after deletion are