Skip to main content

Data Exchange via SFTP Server

Workist provides an SFTP server by default, which can be used for data exchange. This server is secured using private/public key authentication. To use this server, an SSH key pair must be created on the customer side.

info

Instructions: Create an SSH Key Pair

Connection Details​

info

You can find the full connection details (host, port, RSA fingerprint and IP addresses) in the Workbench under SFTP Public Keys.

Directory Structure​

DirectoryPurpose
/exportMaster data lists for validation lookups (exported from ERP)
/incomingOutput file with document data (e.g. XML) and original attachment (PDF)
/archiveOptional for preferred use

Testing the Connection​

sftp -i <path/to/private_key> -P <port> <user>@<sftp-host>
scp -i <path/to/private_key> <path/to/test_file> <user>@<sftp-host>:/export
scp -i <path/to/private_key> <user>@<sftp-host>:/export/<test_file> <path/to/local_dir>

Creating an SSH Key Pair​

Windows​

ssh-keygen -t ed25519 -C "your_email@example.com"

For older systems without Ed25519 support:

ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

Note: ssh-keygen requires OpenSSH to be installed.

Linux and Mac​

ssh-keygen -t ed25519 -C "your_email@example.com"

Follow the prompts in the terminal:

  1. Confirm or adjust the save path (default: ~/.ssh/id_ed25519)
  2. Enter an optional passphrase
  3. The key will be generated and saved

PuTTY (Windows)​

  1. Download PuTTY from the official website
  2. Open PuTTY Key Generator
  3. Select RSA, click "Generate" and move the mouse over the empty area
  4. Copy the public key or send it directly to Workist
  5. Save the private key: Conversions → Export OpenSSH Key

Using the Key Pair​

  • Share the public key (file extension .pub) with Workist
  • Store the private key (without file extension) on the system that communicates with the SFTP server