Skip to main content

​
Extra information

System documentation: https://iceclog.com/manual-for-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
  1. In the 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. Both Live Icecat or Data Icecat have two different purposes and you can view their documention here:
  2. Fill in the Base URI either https://live.icecat.biz or https://data.icecat.biz
  3. We can choose the authentication type of this client. There are two options: “No Authentication” and “Basic Authentication”.
    • On “Basic Authentication” a username and password of Icecat account will be provided.
Icecat connector screenshot 1
  1. Save the HTTP Client for use.

​
2. Subscribing to Entities from Icecat

2.1 Steps
  1. Go to Connections -> Incoming, create a new incoming configuration, and select the Icecat Subscriber as the subscriber.
  2. Select the entity you want to subscribe to from Icecat.
  3. You can optionally add a transformer to transform the request parameters into something you need.
  4. You can optionally add a transformer to modify the request parameters into something you need.
  5. Select the Icecat HTTP Client to use.
  6. 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 to from Icecat. Please refer to the entities in Management APIs from the Icecat API Reference page. Request Parameters These are the parameters you can provide to get the needed entity based on the Icecat API reference. Icecat connector screenshot 2
  • Live Icecat Incoming/Subscriber
Example: Icecat connector screenshot 3
  • Data Icecat Incoming/Subscriber
(Notes: Data Icecat can only 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: Icecat connector screenshot 4
  • “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
Input Transformer Any transformers set here will be executed after the Request Parameters are loaded. So, you basically can add any transformer to provide and modify 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.