Import from APIs

Import product feed data from APIs in Productsup.

An Application Programming Interface (API) is a method for transporting data through the sending of responses and receiving requests. It lets two systems talk directly with each other and in our case to send product data.

Importing data via API is a popular choice for product data, as it typically allows dynamic and quick data handling.

Productsup has a number of API connections directly to external systems. See Import data from third-party external systems.

We also have some more general methods of importing from “standard” APIs, including our own Productsup Platform API.

Import data via the Productsup Platform API

You can import your product data by integrating your system with the Productsup Platform API.

  1. Navigate to your site

  2. Navigate to Data Sources

  3. Click add data ource

  4. Add the Productsup Platform API data source

  5. Give your data source a specialized name (if desired)

    1. This will replace the name of the data source option on the data sources overview page

  6. Click Continue

  7. Set the product update mode to either replace or update

    1. replace will upload a full file of all product information on each run

    2. update will only upload fields that have changed data (delta update)

  8. Enter an email address under the import process report email address field, if desired

    1. you will receive an email for each import, containing a log of the batch IDs that were imported

  9. Add a description (if desired)

    1. This is another chance to add a specialized name (see step 5)

  10. Click Save

    api.png

To explore this topic in greater depth, see API Documentation or go directly to the Productsup Platform API developer website.

Import from a basic SOAP API

To import data from a SOAP Service, you should:

  1. Navigate to your site

  2. Navigate to Data Sources

  3. Click add data source

  4. Add the Basic SOAP Request data source

  5. Give your data source a specialized name (if desired)

    1. This will replace the name of the data source option on the data sources overview page

  6. Click Continue

  7. Add the link to your data under the WSDL URL field

  8. Define the root node of your file under the XML root node field

  9. Provide a SOAP Endpoint

  10. You can specify parameters if desired under request parameters

    1. this will only import the products included in the parameters

  11. Add authentication (if needed) by defining the Auth Type from the drop-down menu, and adding the Auth User and Auth Pass

  12. Add a description (if desired)

    1. This is another chance to add a specialized name (see step 5)

  13. Click Save

    soap.png

Import paginated data through a basic REST API (JSON)

To import paginated product data in a JSON format through a basic REST API, you should:

  1. Navigate to your site

  2. Navigate to Data Sources

  3. Click add data source

  4. Add the Basic API Request with JSON Response data source

  5. Give your data source a specialized name (if desired)

    1. This will replace the name of the data source option on the data sources overview page

  6. Click Continue

  7. Add the URL to your data under Source

  8. If the URL contains any parameters that are not the page parameter, please add them here

  9. If authentication is needed, you can add the username and password

  10. Add the root and variant nodes for your JSON file (if necessary)

  11. Input the variable which defines the page under page variable

    1. i.e. for the following example, the page variable would be page: www.myonlineshop.com/export.json?page=1

  12. Set the page interval under the next page interval

    1. This is necessary if the pages do not increase by one each time, for example, if not page=1, page=2,….

  13. If you want to bundle repeating nodes, activate bundle elements and add a bundle delimiter

  14. Set a notification interval, which will inform you at a certain interval how many products have been imported

  15. Define how many requests occur at one time under the concurrency field

  16. Add a description (if desired)

    1. This is another chance to add a specialized name (see step 5)

  17. Click Save

    basic_api_old.png

Import through a basic REST API using cursors (JSON)

If you need to use cursors instead of pagination to page larger result sets, you should:

  1. Navigate to your site

  2. Navigate to Data Sources

  3. Click add data source

  4. Add the Basic API Request with JSON Response (Cursors) data source

  5. Give your data source a specialized name (if desired)

    1. This will replace the name of the data source option in the data sources overview page

  6. Click Continue

  7. Add the URL to your data under Source

  8. If the URL contains any parameters you wish to include, please add them here

  9. If authentication is needed, you can add the username and password

  10. Add the root node and variant node for your JSON file (if necessary)

  11. Set a notification interval, which will inform you at a certain interval how many products have been imported

  12. Add in the cursor location, as well as the cursor response header and the cursor request header

  13. Add a description (if desired)

    1. This is another chance to add a specialized name (see step 5)

  14. Click Save