API Requirements for Connectors

The connector will be developed by the development team of Pixelz. To allow this, the following methods or informations need to be accessible in the third party API.

API Context: For the individual client only. The client needs to give Pixelz permission by providing an API key or token.

Technical: Any type of API that can be accessed via HTTP(S).

REST and SOAP are highly recommended. Same with JSON or XML data. If you have SDK please provide us with the library and sample code if available.

Sandbox account (required)

Please provide a store sandbox account for testing purposes. In the sandbox account, we can add categories, products, images, and then use the API to interact with it.

Get API key or token (optional)

We (Pixelz) would like access to the customer’s store, using your API, so we need the API key or token. If we can get it programmatically, it would be the best experience for the customer. If the customer must use the token manually, it may lead to an extra step and sometimes customers do not know where to find the token. We do NOT recommend customers to provide their usernames and passwords to Pixelz.

Get Product categories (optional)

This method provides the list of product categories of the client.
Without this method, the connector can work, but lacks some features (Image Analytics, Publish).

  • Category Id
  • Category Name
  • Additional filter information: language, deactivated, number of products

Get Products (optional)

This method provides the list of the client’s products. May have filter, pagination. Without this method, the connector can work, but lacks some important features (Image Analytics, Publish).

  • Product Id
  • Product number/SKU/code/etc
  • Product categories
  • Product name
  • Last updated (for incremental sync)
  • Additional filter information: language, deactivated, number of images

Get Images (required)

This method provides the list of images of a product, or a list of images by some filter conditions. May have filter, pagination.

  • Image Id
  • Product Id (if only one product per image, can also be on product if fixed amount)
  • Image URL (original image)
  • Additional filter information: dimension size, recommendation, thumbnail URL, etc.
  • Current image position (Optional)

Post Product (optional)

This method will allow Pixelz to update your products with new images automatically. Without this method, the connector can work but lacks some important features (Publish).

  • Product Id
  • New list of images URL (Temporary – images must be copied to another location)

Post Image (optional)

This method will allow Pixelz to update (overwrite) your existing image with a new image. Without this method, the connector can work but lack some important features.

  • Image Id
  • New image URL (Temporary – image must be copied to another location)
  • New image position (optional)

Add Image (optional)

This method will allow Pixelz to add a new image to a product. Without this method, the connector can work, but lacks some important features.

  • Product Id
  • New image URL (Temporary – image must be copied to another location)
  • Image Position (Optional)

Get Count (optional)

  • Count number of categories
  • Count number of products
  • Count number of images