Using Product CSV APIs

How to use Api53 API

You can use our API to download the product CSV file. However, the product API has a limitation of requests from the API user's perspective. In order to get access to the product API, an API endpoint owner must add you as a user.

Endpoint

Our Public API Endpoint can be accessed through the following address:

https://api.api53.com

Please note that we only accept TLS connections via the standard port 443 for our API.

To access the Product CSV through our API, you need the following parameters:

• API endpoint address
• API Endpoint ID
• File name
• API User Secret Token

But don't worry, all parameters are automatically emailed to API end-users when adding new users. You can also view them on our dashboard at any time.

The API URL consists of the following resources:

https://api.api53.com/v1/products-csv/<API_ENDPOINT_ID>/<FILE_NAME>

The following example shows what a url might look like:

https://api.api53.com/v1/products-csv/1234567-66af-1234-adba-8ddc7f9d0a7b/products.csv

CSV specification

The CSV specification is declared here. All attributes are described and special attributes such as "custom_attributes" or "category" are described.

The attribute category consists of parent and child category. We have chosen this approach so that categories can be clearly identified. As the data type, we have decided to use JSON Multi-dimensional Array, since a product can have multiple categories. The JSON Multi-dimensional Array is in "stringify" format. Which means you have to use JSON parse to get them displayed correctly.

Let's look at the following example:

We have a product which is in two categories. In the category "Men" -> "T-Shirt" and the category "Special Offers" -> "New"

• Men (Parent category)
  • T-Shirt (Child category)
• Special Offers (Parent category)
  • New (Child category)

The Multi-dimensional Array would look like this for the example above (parsed, which means not stringified):

[
  ["Men", "T-Shirt"],
  ["Special Offers", "New"]
]

The custom attributes can represent all other attributes that a product has. By default, all product data is sent to Api53. Thus, we also store other attributes in our database. The custom attributes are returned in a CSV as a string. The string is a stringified JSON object. To make use of them, just like category, you have to use JSON parse first.

Limits

All our API requests are limited and constantly monitored. The API requests are limited per API Secret Token. The requests are also limited to a time window of one month. How many API requests you can make depends on the plan purchased by whoever uses our service and provides you with the API users.

We distinguish between two subscription versions. A paid version and a free version of our product.

• Free Version:
  • Quota: 300 requests per month starting on the 1st day
  • Rate: 50 requests per second
• Paid Version:
  • Quota: 20.000 requests per month starting on the 1st day
  • Rate: 50 requests per second

If you want to learn more about our product, please visit our Pricing page.

We do not create pagination for CSV files. This means that all products are in one file for version 1 of the API (/v1/). When loading our CSV file, please bear in mind that depending on the quantity of the products, a CSV can be very large.

Request and Response

Requests are generally formatted as follows:

GET object/:object_id

Example Request

The following example shows how to communicate with our API using cURL:

$ curl -X GET -H "X-Api-Key: ABC1234567890" https://api.api53.com/v1/products-csv/1234567-66af-1234-adba-8ddc7f9d0a7b/products.csv
product_name,sku,quantity,price,brand,weight,category,image_thumbnail,image_base,status,description,custom_attributes
...
...
...