Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
System documentation: Ecwid API Reference
Connector package documentation
Table of Contents
- 1. Setting up HTTP Client Ecwid
- 1.1 Steps
- 2. Subscribing to entities from Ecwid
- 2.1 Steps
- 2.2 General concept
- 3. Publishing entity to Ecwid
- 3.1 Steps
- 3.2 General concept
1. Setting up HTTP Client Ecwid
- In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
- Select Ecwid HTTP Client as PlatForm and click the next step
- Fill in the Base URI, Store ID, and Client ID and select the Authentication Type of your Ecwid instance (OAuth or using access Token.
- You can optionally set a base HTTP client to use for the connection by selecting an HTTP client configuration or setting your own HTTP client in the Advanced HTTP client field
- Click the Grant access to Ecwid button to get the access token (If you’re using Oauth as your Authentication Type).
- You can optionally change how Alumio logs every HTTP request made by the HTTP client
- Click the next step, fill in the name of the HTTP Client, and finally, you can save the HTTP Client for use.
2. Subscribing to Entities from Ecwid
- Go to Connections → Incoming, create a new incoming configuration, and select Ecwid Subscriber as the subscriber.
- Select the entity you want to subscribe from Ecwid.
- Add any request parameters needed to subscribe to the entity (optional).
- Select the Ecwid HTTP Client to use
- You can optionally add a transformer to transform the request parameters into something you will request from Ecwid.
- You can also optionally enable pagination to allow Alumio to fetch paginated entities.
2.2 General Concept
We follow Ecwid API documentation on building this connector, so you can easily use the connector based on Ecwid API Reference.
It’s the entity you want to do (fetching data from Ecwid). Please refer to the Ecwid API Reference page.
It’s the parameters you can provide to get the needed entity based on Ecwid API Reference Documentation. For example, we want to subscribe to Product details with endpoint /products/596377786 with productId = 596377786. We add this Json at the Request parameter area.
It will transform to /products/596377786
That’s why we need to define the Product ID property inside the payload property in the Request Parameters field.
Alumio will then make a request to Ecwid.
Any transformers set here will be executed after the Request Parameters are loaded. So, you 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.
The HTTP Client configuration you will use to access Ecwid.
3. Publishing Entity to Ecwid
- Go to Connections → Outgoing, create a new outgoing configuration, and select “Ecwid Publisher” as the publisher.
- Select the Method you want the publisher to use with the data.
- Select the Ecwid entity to which the data will be published.
- 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). However, you can also add or modify the payload using the Request Transformer.
Currently, we support POST, PUT, and DELETE methods.
We support publishing to most Ecwid endpoints but not with publishing binary files at the moment. Please refer to the entities from the Ecwid API Reference page. Based on the documentation, some endpoints may need one or more path parameters.
We support publishing to most Ecwid endpoints. Please refer to Ecwid API Reference Documentation page.
Please look at the example below. For example, we want to update a product with productId = 596377786 by using the patch method. Please select method PUT and “Products - Update a Product” as the entity action of the publisher.
The documentation describes that we need Product property as a request body. In that case, you need to provide the Product property into the payload property in the data, either as an output from Routes or output from Transformers in the Outgoing Configuration. Here is an example of the required data.
It’s the HTTP Client configuration or prototype that you will use to access Ecwid.