Pixc Public API

Optimize your store's product photos using our public API. Following our public documentation, your developer can implement our API, providing your store with consistency and uniformed photo standards.

Introduction

Pixc Public API allows you to automatically optimize photos within your app in no time. If you're an online store or a marketplace with the continuous flow of photos uploaded, Pixc can help you to keep consistent photo standards and create a uniform style of your online store.

With Pixc API you can:

Set your photo standards (templates)
Send your photos to Pixc on on-going basis (Pixc creates an order automatically)
Get your optimized photos within 24 hours (.zip or list of URLs)

Essentially, if you have photos being uploaded to your store on a regular basis, Pixc Public API will help you to automate photo optimization (background removal, size, ratio, file type adjustments, adding shadows and reflections and many other things). For example: you're a marketplace that sells different products from individuals. They take a picture, upload it to your marketplace, Pixc automatically gets those photos (POST /api/order) and you receive the list of URLs (GET /api/order/{orderId}/download), that you can use to create awesome product listings in line with your standards.

Results:

You have a professionally looking online marketplace
Your vendors don't have to deal with the image editing
Customers are happy to shop at your store

Sounds like a plan? Read on!

Getting Started

Pixc Public API allows developers to communicate with Pixc platform via REST API.

First of all, you need an Access Token. It can be obtained under Account Settings > API Access section of Pixc Dashboard.

If you don't have a Pixc account, you can create one here.

Authorization header format:

Authorization: Bearer ACCESS_TOKEN

Please make sure your requests are authenticated. Here is an example that returns order lists:

curl -X GET \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer ACCESS_TOKEN' \
  'https://dashboard.pixc.com/v1/api/order'

In order to test the API without performing real calls, a special test: true header can be used:

curl -X GET \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer ACCESS_TOKEN' \
  --header 'test: true' \
  'https://dashboard.pixc.com/v1/api/order'

This will perform "fake" calls. Input data validation rules and authentication checks will be applied, but test calls never modify data in the account.

Libraries

Node.js

API Reference

Below is a full list of API endpoints with all input and output data schemas, and examples of requests.

You can try authenticated requests by toggling the OFF switch — it will ask you to authorize at Pixc. Just enter your Pixc email and password.