Platform setup
Set up a Stream API data source in the platform UI so a site imports the data you upload to a stream.
Uploading data to a stream does not import it anywhere on its own. A site needs a Stream API data source pointing at your stream before an import picks the data up.
You can create that data source in two ways: through the platform UI, as described on this page, or through the Site stream data sources endpoint. Neither requires special platform knowledge.
Prerequisites
To set up the import with Stream API, you need to have:
- User access to the Productsup platform
- A site in the Productsup platform ready for data import
- The stream ID and stream name(s).
If you don't have any of the listed components, contact your Productsup Customer Success Manager or our Technical Support Team via support@productsup.com.
Set up an import
To create Stream API data sources via the API instead, use the Site stream data sources endpoint.
- Open your site in the platform and go to Data Sources in the main menu.
- Select Add Data Source.
- In the search field, enter Stream API and find Stream API Data Source.
- Select Add to add the data source.
- Give your data source a custom name, as desired, to identify it among multiple data sources.
- Select Next and get to Data Source Configuration page.
- Select the stream you want to import from. You can use the label Stream to find it later.
- Change the description, as needed.
- Select Save and get back to the Data Sources page.
- If your stream already contains data, select Import in the upper-right corner to import the data.
- View your imported data in Data View.
Empty data sources
By default, the platform skips the import if a data source is empty, because an empty import fails. If your stream is empty — for instance, because you emptied it — the import does not run and the data already in your site stays untouched.
Some integrations need the opposite behavior: the empty stream gets imported, and the site's imported data is cleared as a result. This is not a common scenario. To allow it, take the following steps:
- Open your site in the platform and go to Data Sources in the main menu.
- Edit the Stream API data source.
- Go to the tab Advanced Settings.
- Go to Options.
- Check the checkbox Allow this datasource to have no products.
- Select Save Options.
To go back to skipping empty imports, repeat the preceding steps and, in step 5, uncheck Allow this datasource to have no products.
Platform recommendations
We don't recommend enabling Allow this datasource to have no products by default. With the option active, an import from an empty stream succeeds instead of failing, and clears the data already imported into your site. Enable it only if importing an empty stream is the outcome you want.
We recommend setting up the error event Number of imported items decreased in Monitor in the main menu of our platform. Set a threshold in percentage within which your product numbers can decrease. If the product number is less than the threshold, the platform takes an action. For example, the platform stops the import and sends you a notification via email or Slack.
How is this guide?