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?
The advantage with SFTP file transfers is that they are secure. The system exporting the files - in this case, Sapling - needs to be approved by the one receiving the files through authentication. There are two ways for Sapling to authenticate with your SFTP server:
- User credentials
- Public/ Private key pairs
User credentials
This method uses a username and password to authenticate with your SFTP server:
- These credentials are typically created by your SFTP administrator
- When setting up your SFTP connection in Sapling, you’ll enter the username and password provided
Public/Private Key Pair (Recommended)
This method uses a username and public/private key pair (instead of password) to securely authenticate with your SFTP server. Using your own tools, your SFTP administrator will need to generate:
- A username
- A private key file
- A public key file
Once generated:
- You'll need to enter the username and upload the private key file to Sapling during the SFTP connection setup
- Your SFTP administrator will need to install the public key on your SFTP server
This authentication method is more secure than using credentials and is recommended for automated, ongoing data exports.
How to Connect to an SFTP Server
If you want to connect an SFTP space where you can export data from Sapling, you'll need to have the details of that SFTP server ready before you connect it with Sapling.
- Navigate to the 'Integrations' page and click on the SFTP tab
- Once there, click ‘Create SFTP space’
- Give your SFTP space a name – this is how you will identify the space when choosing where you will export reports to
- Enter the Host – this is the URL of your SFTP
- Choose your authentication method - this will be either Credentials or Public/ Private key
- If you've selected Credentials, add the Username and Password that can be used to authenticate with your SFTP server
- If you've selected Public/ Private key, add your username and then upload the private key file you have generated as the private key
- 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
- Enter the folder path. This is the folder within the SFTP space you would like the reports exported to
- 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.