SFTP

Beside the API access, we can process files located on your SFTP server. For this, after you’ve provided us with your server details, we’ll set up 5 folders in the root folder: ./in, ./processing, ./processed, ./interlaced, ./error. We’ll also set up subfolders in the /in folder, each named after one of your configs/products.

When processing pictures, our service worker will:

  • list all files in each subfolder of ./in
  • move them, as they are downloaded and queued for processing, into ./processing
  • when processing is complete, put the result file into ./interlaced, and the original file into ./processed
  • in case of an error, move the original file into ./error, with an additional [full original name].txt file describing the error (its content is similar to API error return)

As files are moved and created, they retain their subfolder as well (i.e., ./in/config_name/example.png will be moved to ./processing/config_name/example.png)

When configuring your SFTP server, you need to indicate a time when processing can start. The service worker will start queuing your pictures on or after the indicated time, and will continue to do so until it finds no more pictures to process. If your SFTP server has a small bandwidth compared to the amount of pending pictures, or if we are facing an exceptional load on our side, the worker may keep queing pictures after the indicated time.