About the Spryker Dynamic Data Exchange 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: Spryker Dynamic Data Exchange API Reference

Connector package documentation

1. Setting up HTTP Client Spryker Dynamic Data Exchange

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select “Spryker Dynamic Data Exchange HTTP Client” as the HTTP Client.
Fill in the Base URI, Username, Password.
You can optionally enable caching the token to save the token(using Alumio storage).
You can optionally enable logging of request to get the log of the authentication.
Save the HTTP Client for use.

2. Subscribing to Entities from Spryker Dynamic Data Exchange

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select “Spryker Dynamic Data Exchange Subscriber” as the subscriber.
Select the entity you want to subscribe to from Spryker Dynamic Data Exchange.
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 Spryker Dynamic Data Exchange.
You can also optionally enable pagination to allow Alumio fetches paginated entities.
Select the Spryker Dynamic Data Exchange HTTP Client to use.

2.2 General Concept

We follow Spryker Dynamic Data Exchange documentation on building this connector, so you can easily use the connector based on Spryker Dynamic Data Exchange API Reference.

Entity

The entity you want to subscribe to Spryker Dynamic Data Exchange. Please refer to the entities from Spryker Dynamic Data Exchange API Reference.

Request Parameters

These are the parameters you can provide to get the needed entity based on the Spryker Dynamic Data Exchange API Reference.

Please look at the example below on how to fill path field when subscribing “Get Item of product-abstracts” entity.

Based on the documentation, we can see that the end point require “id” as a path. That is why we set the “id” 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 then make a request to Spryker Dynamic Data Exchange with the URL /dynamic-entity/product-abstracts/1234

HTTP Client

The HTTP Client configuration you will use to access Spryker Dynamic Data Exchange.

3. Publishing Entity to Spryker Dynamic Data Exchange

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “Spryker Dynamic Data Exchange Publisher” as the publisher.
Select the method that you want the publisher to perform with the data.
Select the Spryker Dynamic Data Exchange 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.

Method

Currently we support POST, PUT and PATCH methods on submitting data to Spryker Dynamic Data Exchange.

Entity

We support publishing to most Spryker Dynamic Data Exchange endpoints.

For example, we want to save collection of product-abstracts. Please select “POST” for the method then “Save collection of product-abstracts” as the entity of the publisher.

Based on the documentation, we need to add data. So we put the data inside the payload key in the Alumio Data.

Alumio will send an API request to Spryker Dynamic Data Exchange with URL /dynamic-entity/product-abstracts

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.