About the CS-Cart category

Alumio_Bot · August 23, 2023, 8:24am

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

Extra information

System documentation: CS-Cart API Reference

Connector package documentation

1. Setting up HTTP Client CS-Cart

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select “CS-Cart HTTP Client” as the HTTP Client.
Fill in the Base URI, Email, and API Key.
(For more information, see CS-Cart Authentication Reference)
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 CS-Cart

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select “CS-Cart Subscriber” as the subscriber.
Select the Object to subscribe to from CS-Cart.
Fill in the Object Id (optional).
Select Nested Object (optional).
Fill in the Nested Object Id (optional).
Add any Query parameters needed to subscribe.
You can optionally add a transformer to transform the request parameters into something you will request from CS-Cart.
You can also optionally enable pagination to allow Alumio fetches paginated entities.
Select the CS-Cart HTTP Client to use.

2.2 General Concept

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

Object

The object you want to subscribe to CS-Cart. Please refer to the object from CS-Cart API Reference page.

Query Parameters

These are the query parameters you can provide based on the CS-Cart API Reference page…

Please look at the example below on how to fill object when we try to get a particular “product variation” of a particular “product variation group”.

Based on the Documentation, we pick the “Product Variation Groups” as the Object, then fill 1 in the “Object Id”. We continue by pick “Product Variations” as the Nested Object and filling 1 in the “Nested Object Id”.

Alumio will then make a request to CS-Cart with the URL /product_variations_groups/1/product_variations/1 and get this specific product variation.

Query Parameters is 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 CS-Cart.

3. Publishing Entity to CS-Cart

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “CS-Cart Publisher” as the publisher.
Select the Method that you want the publisher to perform with the data.
Select the CS-Cart Object you want the data to be published to.
Fill in the Object Id (optional).
Select Nested Object (optional).
Fill in the Nested Object Id (optional).
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.

Object

We support publishing to most CS-Cart endpoints.
Please refer to CS-Cart API Reference page.

For example, we want to create a product. Please select Post as the method and “Products” as the object of the publisher.
We don’t have to fill in the “Object Id” and “Nested Object Id”, we also don’t need to select anything from the “Nested Object.”

Based on the documentation, we need to add a Body Request. So we put the body inside the payload key in the Data.

Alumio will send an API request to CS-Cart with URL /products
CS-Cart will then return the newly created “product_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.