About the WICS WMS category

o.plokha · December 9, 2024, 10:30am

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

Extra information

System documentation: WICS WMS API Reference

Connector package documentation

1. Setting up HTTP Client WICS WMS

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select WICS WMS HTTP Client as PlatForm and click next step
Fill in the Base URI, API Key and API Secret.
(See the WICS WMS Token Authentication Documentation for more information)
You can optionally enable logging of request to get the log of the authentication.
Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.

2. Subscribing to Entities from WICS WMS

2.1 Steps

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

2.2 General Concept

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

Entity

The entity you want to subscribe to WICS WMS. Please refer to the entities from WICS 2.0 API Reference page.

Request Parameters

You can provide these parameters to get the needed entity based on the WICS WMS API Reference.

Please look at the example below on how to fill path field when we want retrieve list of task by subscribing “Stock - Get stock item” entity.

From the end point, we can see that we need to set the item code as a parameter. That is why we set the “itemCode” inside the path key in the Request Parameters.

Alumio will then make a request to WICS with the URL /api/stock/12345

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

HTTP Client

The HTTP Client configuration you will use to access WICS WMS.

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “WICS WMS Publisher” as the publisher.
Select the Method you want the publisher to use with the data.
Select the WICS entity you want the data to be published to.
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 HTTP Post method, HTTP Put method and HTTP Delete method on submitting data to WICS.

Entity

We support publishing to all WICS WMS 2.0 endpoints.
Please refer to WICS WMS API Reference page.

For example, we want to update an item. Please select “Put” as the Method and “Items - Update Item”.

From the documentation, we can see that we need to set a path parameter and a body parameter. That is why we set the “identifier” inside the path key and body parameters inside the payload key in the data.

Alumio will send an API request to WICS with URL /api/item/12345

Path is the path parameter of the URL. For example the {id}.
Query is a 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.