SFTP event file configuration tutorial

Besides using cloud-storage, you have the option to consume the event files using a Secure File Transfer Protocol (SFTP) service. The Pismo SFTP service abstracts the AWS S3 service and serves it as an SFTP layer. When you connect using SFTP, you are actually accessing the Pismo S3 bucket.

📘

Keep in mind that, while you can access event JSON schemas rendered as HTML, you need an AWS account to access JSON schemas in Pismo's S3 storage bucket for AWS documentation.

To use SFTP for file delivery, you need the following:

1. SFTP client

   This is a software program that allows users to log in to remote SFTP servers.

2. Secure Shell (SSH) key pair

   An SSH key pair consists of a private key and a public key. You share the public key PIsmo. This enables you to securely connect to Pismo via SFTP. You should securely store the private key in an encrypted format.

To configure SFTP for Pismo file delivery:

1. Download and install an SFTP client like Filezilla or WinSCP. Alternatively, you can implement your own client in Java, .Net, Go, Python, or another programming language.

2. Generate an SSH key pair.

   If you're running Windows, you can do this by following the directions on this site: Generate an SSH Key Pair on Windows Using the PuTTYgen Program.

   If you're running Linux, you can follow the directions at: Git on the Server - Generating Your SSH Public Key.

   After you generate an SSH key pair, send the public key to Pismo. This key will be linked with your login username when you set up SFTP access with Pismo. The public key should look similar to this:

ssh-rs
AAAAB3NzaC1yc2EAAAADAQABAAABAQCwskg9UmvUCUCscqNPgpSMzMUOcpSLzESz+d8RFa+YLkMEO5doyLskdisssjtxFz8A+fW/m4XVB+DyLHoS8pxmRfML/+DyhIb40GJbGV0xcAYC0IrmNXb8ldzMU0FGyIh5r2dZtH5mK9MeDBIZeYASrVLjbyflUy6JWCUUKYFSnm1eCIzmgGYHfYQqf+doCSKItGxpB9G3HhvBXsEvlka93aZRkGiEGTNHDGQ1NooksIKJSltk2ik1XfSADZfex0xrKBmlq/uy2/HXZ3lPQrIaN9fswA7+BLES/s9LZ9C0FC2uD2AwQbpJigqUihHuC7q+zIssWWWksjdkxb1jOljvej

📘

You can associate up to 8 keys with your organization.

3. Open up a ticket at the Pismo Service Desk with your public key(s) attached and request SFTP access for your organization.

4. Configure your SFTP client with your private key. It will store this key in an encrypted format and use it when it connects to Pismo's SFTP service.

5. After you receive your login information from Pismo, you can use your SFTP client to connect to PIsmo and retrieve event files.

Accessing the SFTP service from the development and production environments

Each Org ID has its own set of credentials, so development and production access are not the same. The development and production environments have the following access endpoints:

Knowing when files are available

To be notified when there is a new file available, you need to set up real-time event notifications through a cloud account. Otherwise, you will have to periodically open a connection and check for new files.