Sapling - How to Connect an SFTP Space

introduction

What is an SFTP

SFTP stands for Secure File Transfer Protocol. It is a secure way to transfer files directly from one server to another.

Many people use SFTPs to integrate with 3rd party applications. Some platforms only allow integration via data transfer through SFTP. Once you have an SFTP server connected you can export reports directly to that SFTP server.

This article will cover the following topics:

• What types of authentication can a connected SFTP use?
• How to connect an SFTP server?

What types of authentication can a connected SFTP use?

The key thing with SFTP file transfers is that they are secure. The system that's exporting - in this case Sapling - needs to be approved by the one that is receiving the files through authentication. There are two main ways to authenticate that the Sapling should be able to transfer files to a connected SFTP server.

• Credentials
• Public/ Private key pairs

Credentials users user name and password to authenticate. These credentials can be set up when setting up the administrator for your SFTP

Public/ Private key pairs use a username as well, but instead of a password, the system that is exporting uses an encrypted key to show that it is authenticated. These keys come in pairs - the SFTP keeps the private key, while any system that is exporting to that SFTP uses the public key. 

How to Connect to an SFTP Server

If you want to connect an SFTP space that you can export data to from Sapling, you'll need to have the details of that SFTP server ready before you connect it with Sapling. 

1. Navigate to the 'Integrations' page and click on the SFTP tab.
2. Once there, click ‘Create SFTP space’.
3. Give your SFTP space a name – this is how you will identify the space when choosing where you will export reports to,
4. Enter the Host – this is the URL of your SFTP.
5. Choose your authentication method - this will be either Credentials or Public/ Private key.
6. If you've selected Credentials, add the Username and Password that can be used to authenticate with your SFTP server
7. If you've selected Public/ Private key, add your username and then upload the file with the encrypted public key.
8. Enter the Port number. This is by default usually set to 22, however when creating an SFTP space it can be configured to other ports.
9. Enter the folder path. This is the folder within the SFTP space you would like the reports exported to.
10. Click ‘Next’ and review, then click ‘Save’. Your SFTP space will then be connected and you will be able to see it in the list of SFTP spaces.

If you would like to verify that the connection is established correctly you can send a test file to your SFTP space. To do this find the SFTP space you would like to send a test file to, then click ‘Actions’ and then ‘Test’. We will then send a verification file to the previously indicated folder in the SFTP space to confirm that the space is properly connected.

Once you've connected your SFTP space with Sapling, you can then start exporting reports to your SFTP server.