About the DynamicWeb category

anon99371720 · March 1, 2023, 9:06am

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

Extra information

System documentation: Swagger UI

Connector package documentation

1. Setting up HTTP Client DynamicWeb

1.1 Steps

In Alumio Dashboard, go to Storages > Storages. Create a new Storage and select default Prototype as the prototype of the Storage.
Check the Enable pruning of storage items and Set the Time to live at 30 minutes

Save the Storage.
In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select DynamicWeb HTTP Client as the prototype of the HTTP Client.
Fill in the Base URI, Username, Password, Shop Id and expiration in Seconds. You need to change the storage time to live when changing expiration in seconds accordingly.
Set the storage as the one that you save at previous step.
You can optionally enable logging of request to get the log of the authentication.
Save the HTTP Client.

2. Subscribing to Entities from DynamicWeb

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select DynamicWeb Subscriber as the subscriber.
Select the entity you want to subscribe from DynamicWeb.
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 DynamicWeb HTTP Client to use.

2.2 General Concept

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

Entity

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

Request Parameters

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

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

Because the id is inside path, we put it like that. This will be sent to DynamicWeb system as /dwapi/ecommerce/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 you will use to access DynamicWeb.

3. Publishing Entity to DynamicWeb

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select DynamicWeb Publisher.
Select the method that you want the publisher to do with the data currently DynamicWeb support Post, Put, Patch and Delete.
Select the DynamicWeb entity you want the data to be published to.
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).

Method

Currently we support Post, Put, Patch and Delete.

Entity

We support publishing to most DynamicWeb endpoints. Please refer to the entities from DynamicWeb 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 Create a new user. Please select “Post” as the method and “Users_Create” as the entity of the publisher.

You can put the payload you want to send to DynamicWeb into payload property in the data. Here is an example of the Payload for creating the user.

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 DynamicWeb with URL /dwapi/users/create