Import methods

In Synerise, you can import three types of files in three possible ways:

  • Push - Continuous import
  • Pull - SFTP or API
  • File upload

Requirements


  • You must belong to the user group that has a permission to preview, create and execute imports.
  • The Business Profile API key configuration must allow imports.
  • Prepare files according to the specification available here.

Pull


This type of import is useful when you access your data over SFTP or HTTP and you would like to update the data in Synerise by periodical imports.

Image presents the wizard of imports
The wizard of imports
  1. Click the New import button.

  2. Choose the type of the import (for example, client, transactions or product feed).

  3. Choose Pull - SFTP or API option as a method of the import.

    • Scenario for SFTP:

      1. Type the name of the server and the port number (usually, it’s 22).
      2. Select a connection type. The Guest type does not require further information. The User name requires your SFTP storage credentials. The Key requires your login to your SFTP storage and the public key. In case you go for the Key, follow the procedure:
        1. Download and save the public key by clicking the Download button.
        2. In the text editor, open the public key and copy it.
        3. Log in to the server.
        4. In a text editor, open the authorized_hosts file in .ssh which should be stored in your directory (for user1 it is /home/user1/.ssh/authorized_hosts).
        5. Paste the public key at the end of the authorized_hostsfile.
        6. Save the changes in the file.
      3. If your data are stored in a directory, provide a path to it (for example, /home/some-directory/).
      4. Type the full name of the file (together with the file extension, for example synerise.csv. In the case of frequent imports, you can devise a name pattern which will make your work easier with imports.
        • To import all files from the directory that have a common word in the name, use the asterisk (for example, synerise*.csv). Then, all files with names that begin with synerise will be imported.
        • Currently not working: If you want to import several files that have a specific number of characters after the common part of the file name, use a question mark for each sign (for example, synerise???.csv). This way you import all the files whose names consist of a specific number additional signs after the common part of the file name (in this case, it’s synerise).
          • If your files are protected with an access key, tick the checkbox.
          • If your files are protected with an access key, upload it by clicking the Upload key button.
          • Complete the process by clicking the Apply button.
    • Scenario for API:

      1. From the dropdown list, select the appropriate method to import data to the Synerise.
      2. In the Endpoint URL field, provide the address to the endpoint from which the data is retrieved for an import.
      3. Select the Connection type:
        • Guest (if API is public)
        • Authorization header (if API is private).
  4. To define the schedule and frequency of imports, click the Define button.

    • From the Import data every dropdown list, select the frequency of the imported file.
    • Define when you want the import to start. Select the date in the calendar. The import starts on the selected day, but the exact time is not specified.
    • Optionally, you can define the last day of the import.
    • Confirm it by clicking the Apply button.
  5. Upload an exemplary file.

  6. Map the fields by joining the items on the list on the left side with the columns.

  7. Save the import by clicking the Save button.

Result: At the scheduled time, the system starts retrieving data from SFTP or API to Synerise.

Push


Image presents the wizard of imports
Blank push import settings

This type of import allows users to send data on a particular webhook URL. The flow of the import is as follows:

  1. Click the New import button.

  2. Choose the type of the import (for example, client, transactions or product feed).

  3. Choose Push - Continuous import option as a method of the import.

  4. Upload an exemplary file.

  5. Map the fields by joining the items on the list on the left side with the columns.

  6. Save the import by clicking the Save button.
    Result: You receive a webhook URL you can send the data to.

    Important: If you wanted to receive a webhook URL and save the mapping, this is the end of the process. You can use this mapping for one-off imports of the file. To do so, follow the steps described below.
  7. Go to the list of imports and find the push import you have just created (the types of imports aren’t marked on the list).

  8. Go to the details of the import by clicking it.

  9. Click the Import data from CSV button.

  10. Upload the target file to be imported.

    Important: If you want to use this mapping in other import, then the structure of the file (number of columns, name of the columns, and the data format) must be the same.
  11. To complete the process, click the Import button.

File upload


By means of this method, you can prepare a one-off upload of data to Synerise.

  1. Click the New import button.
  2. Choose the type of the import (for example, client, transactions or product feed).
  3. Choose File upload option as a method of the import.
  4. Upload the file with data to import.
  5. Map the fields by joining the items on the list on the left side with the columns.
  6. Save the import by clicking the Save button.

Result: The import begins immediately

😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.