Productsup

Integration

How to integrate the Export API, including authentication, API limits, and endpoint details.

How to integrate the Export API?

The Export API can be accessed by making authenticated HTTP calls to our endpoint. Below you can more detailed information about authentication, filtering, and pagination.

We do provide an Open API 3 specification file in the Resources section.

We currently do not have a client library to interact with the Export API.

Quick overview

  • Hostname: export-api.productsup.com
  • Protocol: https
  • Route: /sites/{siteId}/channels/{channelId}/destinations/{destinationId}/products
  • API limits: 60 requests per minute per channel
  • Maximum products per page: 1000

The full route and token can be found on the [Destination settings(/docs/export-api/setup#destination-settings)

Authentication

The authentication token needs to be sent as a value for the header X-EA-Auth-Token. See the example below for more information.

curl -i -X GET \
 -H "X-EA-Auth-Token:{AUTH_TOKEN}" \
 '{URL}'

The token can be found on the Destination settings page. See How to set up the Export API Destination?

API Limits

To ensure the same quality of service to all users we will implement rate-limiting in the future.

Clients can do up to 60 requests per minute per channel. Once they go over this limit we'll return a response with a 429 Too Many Requests status.

How is this guide?

On this page