Setup
How to access data in the Export API, set up a sandbox environment, and configure the Export API Destination.
How to access data in Export API?
To access the data from the Export API, this integration needs to be set up in the Platform. Since the data for the Export API resides on a separate infrastructure. In the diagram below you can see that the Export API behaves just like any other Destination. Once the Destination is set up for a specific Channel, then an export can be triggered, this will execute the Export API Destination and the data will be pushed to the Export API infrastructure. From that moment on the data is available for querying.
How to setup a sandbox environment for the Export API
This section requires you to have a sandbox project set up. If you don't have such a project in the Platform, you can reach out to your Client Success Manager for support.
- Log in to the Platform
- Go to your Sandbox Project
- Ensure that there is a site with data available - an existing or new sandbox site can be used
The following prerequisites must be satisfied:
- The site should have a data source to import data from
- Mapping of columns in the data view should be set up
- A channel must be created for the Export API (can be any channel)
- Validate, with the help of the data view, that you have data available in your channel
The Export API Destination needs to be unlocked by Productsup. If you are interested in this project reach out to your Productsup contact for more information.
- Reach out to Productsup to have your Export API destination set up This could be your Client Success Manager or also our Tech Support team
- Once the Export API destination is added, it will be visible in the destinations list of your channel
- You can retrieve the URL and Token via by editing the Export API destination, also see the chapter Destination Settings
- Verify that the Export API destination is active, if not, set it to active
- Now you can run an export of the current channel, this will populate the Export API
- Follow up with:
- The chapter How to integrate the Export API provides basic information about the API URL and authentication mechanism
- The chapter Filtering contains details on how to filter and query data
How to set up the Export API Destination?
Currently, the Export API destination needs to be unlocked by Productsup. If you are interested in this project reach out to your Productsup contact for more information.
- Log in to the Platform
- Make sure to have set up a Channel and go to the Channel settings page
- Click on the button Add Destination
- Select the Destination called Export API
- Click on Save (The page will reload and you'll be redirected to the Destination settings page)
- The Destination is now set up correctly and can be tested
- Go back to the Channel setting pages and click on Export this export This will trigger the export for this Channel and execute the Destination
- Verify that the data is available in the Export API
Destination Settings
The Destination settings page reveals two immutable properties, which contain the additional information needed to access your data via the Export API.
- Export API URL - This is the full URL to access your product set exported by this Destination
- Export API Token - This is the authentication token required to make a request to the Export API
Keep in mind that the URL and Token are only valid for each Destination. So if you have multiple Channels and each Channel has it's own Export API Destination, each of those have their own URL and Token.
Below these properties, there are two switch buttons which enable and disable additional filtering options for the export.
- Exclude Skipped Products - When this is enabled, products that have been skipped by ruleboxes will be not visible in the export
- Exclude Internal Attributes - When this is enabled, internal attributes (prefixed by three underscores
___) will not be visible in the export
These toggles allow you to fine-tune the exported dataset according to your needs, ensuring cleaner and more relevant output.
How is this guide?