This procedure allows users to transfer data in and out of Zenoti in a secure way using Secure Shell File Transfer Protocol (SFTP) on the Amazon Web Services (AWS) S3 server.

What is SFTP?

SFTP stands for Secure Shell File Transfer Protocol, which is primarily used for secure data transfer over the internet. The protocol fully supports the security and authentication of SSH (Secure Shell) and is widely used to exchange data between business partners in a variety of industries including financial services, healthcare, media, and entertainment.

Prerequisites

  • SFTP Access: Reach out to your Zenoti Relationship Manager to gain access to SFTP.

  • Clients: A connection to the SFTP end point can be established using commonly available clients such as WinSCP, FileZilla, CyberDuck, LFTP , and OpenSSH clients.

Things to remember

  • Purpose: SFTP access should only be used for business purposes.

  • Access Sharing: Do not share the SFTP access (username and passphrase) with anyone. Only the authorized user must access the service.
    Zenoti will be sharing the details as mentioned below, for establishing connection with the service.

    • Hostname

    • Username

    • Private Key

    • Passphrase

  • Authentication: SFTP is accessible via public internet and is authenticated using SSH keys with a passphrase. No password-based logins allowed.

  • Data Security Protocol: The data in this transfer flows through protocols based on SSH and TLS cryptographic channels.

  • Data Retention: The data you store in the AWS S3 server is retained only for 30 days. Data retention policy cannot be altered or made any exceptions.

  • Client: User should install one of the specified clients (as mentioned in prerequisites) on the machine where data is stored/downloaded.

To establish connection to Zenoti SFTP service using WinSCP (Windows OS)

  1. Launch WinSCP Client.
    Note: Perform the below steps every time you launch WinSCP Client.

  2. Click Tools > Preferences.

  3. In the Preferences window, go to Transfer > Endurance.
    For Enable transfer resume/transfer to temporary filename setting, select Disable radio button.
    Important: If you leave this option enabled, it may lead to:

    1. Increased upload costs or expenses to your system

    2. Decreased upload performance

    3. Failed uploads especially for large files

  4. Go to Transfer > Background.
    Clear the check box Use multiple connections for single transfer.
    Important: If you use this setting, it may result in:

    1. Unpredictable failures in uploading large files.

    2. Silent data corruption

  5. Go to Transfer > Default > Edit

  6. In the WinSCP Transfer settings dialog box, disable the Set Permissions under upload options and the Preserve Timestamp under common options and click on OK.

  7. Now to Login, Enter the following details:

    1. File Protocol: SFTP

    2. Hostname: Enter the hostname shared by Zenoti.

    3. Port Number: Select 22 from the drop-down list.

    4. Username: Enter the username shared by Zenoti.
      Note: You do not require any password. Proceed to Step 8.

  8. Click Advanced > Select the Authentication tab.
    In the Private Key File field, browse and upload the Private Key File shared by Zenoti. Click Ok.

  9. Enter passphrase in the pop-up window and click OK and your connection is established to Zenoti SFTP.

  10. Perform the file transfer.
    You can drag and drop files from source windows to target windows.

To establish connection to Zenoti SFTP service using Cyberduck (Mac OS)

  1. Launch Cyberduck client.

  2. Click Open Connection.

    Enter the following details"

    1. Protocol: Choose SFTP (SSH File Transfer Protocol) from the drop-down list.

    2. Server: Enter the server endpoint shared by Zenoti.

    3. Port Number: Select 22 from the drop-down list.

    4. Username: Enter the username shared by Zenoti.

    5. Password: Leave the password field blank.

    6. SSH Private Key: Enter the private key shared by Zenoti.

  3. Click Connect.

  4. Enter passphrase in the pop-up window.

  5. Perform your file transfer.

Depending on where your files are, do one of the following:

  • In your local directory (the source), choose the files that you want to transfer, and drag and drop them into your Zenoti SFTP directory (the target).

  • From your Zenoti SFTP directory (the source), choose the files that you want to transfer, and drag and drop them into your local directory (the target).

Did this answer your question?