Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.
Extra information
System documentation: Iceclog: Manual for Open Icecat JSON Product Requests
Connector package documentation
Table of Contents
-
1. Setting up HTTP Client Icecat
- 1.1 Steps
-
2. Subscribing to entities from Icecat
- 2.1 Steps
- 2.2 General concept
1. Setting up HTTP Client Icecat
1.1 Steps
- In Alumio Dashboard, go to Clients > HTTPS Client. Create a new HTTP Client and select Icecat HTTP Client as the prototype of the HTTP Client.
We can choose Live Icecat or Data Icecat.
Either Live Icecat or Data Icecat have two different purposes, you can see their documention:- Live Icecat : Iceclog: Manual for Open Icecat JSON Product Requests at chapter 1.
- Data Icecat : Iceclog: Open Catalog Interface (OCI): Manual for Open Icecat XML and Full Icecat XML at chapter 2.3 and 2.4
- Fill in the Base URI either https://live.icecat.biz or https://data.icecat.biz
- We can choose the authentication type of this client. There are two options: “No Authentication” and “Basic Authentication”.
- On “Basic Authentication” will be provided a username and password of Icecat account.
- Save the HTTP Client for use.
2. Subscribing to Entities from Icecat
2.1 Steps
- Go to Connections → Incoming and create a new incoming configuration and select Icecat Subscriber as the subscriber.
- Select the entity you want to subscribe from Icecat.
- You can optionally add a transformer to transform the request parameters into something you need.
- You can optionally add a transformer to transform the request parameters into something you need.
- Select the Icecat HTTP Client to use
- You can add a pagination feature to allow Alumio to fetch a paginated entity.
2.2 General Concept
We follow Icecat documentation on building this connector so you can easily use the connector based on Icecat API Reference.
Entity
It’s the entity you want to subscribe from Icecat. Please refer to the entities in Management APIs from Icecat API Reference page.
Request Parameters
It’s the parameters you can provide to get the needed entity based on Icecat API reference.
- Live Icecat Incoming/Subscriber
Example:
- Data Icecat Incoming/Subscriber
(Notes: Data Icecat only can be accessed using whitelisted IP/Perimeter81)
As their documentation at Icecat API Reference
- Chapter 2.2 Individual Product XML (Meta) Requests (real-time)
- Chapter 2.3 Open Icecat (free) directories, for batch processing
- Chapter 2.4 Full Icecat directories, for batch processing
Example:
Input Transformer
Any transformer’s set here will be executed after the Request Parameters 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
It’s the HTTP Client configuration or prototype you will use to access Icecat.