About the Symson category

anon99371720 · September 21, 2022, 11:11am

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

Extra information

System documentation: SYMSON Api UI

Connector package documentation

1. Setting up HTTP Client Symson

1.1 Steps

In the Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Symson HTTP Client as the prototype of the HTTP Client.
Fill in the Base URL and API key.
Save and this HTTP client will be ready to use.

2. Subscribing to Entities from Symson

2.1 Steps

Go to Connections → Incoming, create a new incoming configuration, and select Symson Subscriber as the subscriber.
Select the entity you want to subscribe to from Symson.
Add any specific request parameters needed to subscribe to the entity (optional).
You could also add a transformer to manipulate the request parameters into something you need later on.
Select the Symson HTTP Client to use.

2.2 General Concept

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

Entity

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

Request Parameters

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

You can see in the example below how we add Request Parameters into Symson “GET all Customers”:

“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 to Symson as /api/v1/customers?pageSize=1

Input Transformer

Any transformers set here will be executed before the Request Parameters are 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

This is the HTTP Client configuration you will use to access Symson.

3. Publishing Entity to Symson

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration, and select Symson Publisher as the publisher.
Select the method that you want the publisher to perform on the data.
Pick the Symson entity that will receive the published data.
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 Symson.
Select the Symson 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 the route, from transformers in the outgoing configuration), though you can also add or modify the payload using the Request Transformer.

Method

Currently, we support the PUT and DELETE method.

Entity

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

For example, we want to Insert/Update a Product. Please select “Put” as the method and “INSERT or UPDATE a Product” as the entity of the publisher.
You can put the payload you want to send to Symson into the payload key in the data as an example:

“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.

Alumio will send an API request to Symson as /api/v1/products