Documentation / Product / Integrations / Custom Integrations

Authorization

Lytics uses SSH File Transfer Protocol (SFTP) to import files into Lytics and to export user data into files on an SFTP server. You can use your own SFTP service or Lytics can provide a managed SFTP server account. Adding an authorization for use in an import or export job differs if you use our own or a Lytics SFTP account.

If you are new to creating authorizations in Lytics, see the Authorizations Dashboard documentation for more information.

  1. Select Custom from the list of providers.
  2. Select the method for authorization. Note that different methods may support different job types. Custom supports the following authorization methods:
  3. Enter a Label to identify your authorization.
  4. (Optional) Enter a Description for further context on your authorization.
  5. Complete the configuration steps needed for your authorization. These steps will vary by method.
  6. Click Save Authorization.

Client SFTP Server Authorization

  1. In the Host text field, enter the host name or IP address of the SFTP server you want to connect to.
  2. In the Port text field, enter the port number for the SFTP server.
  3. In the Username text field, enter the username for the SFTP server.
  4. In the Password text field, enter the password for the SFTP server. If you wish to use a Private Key, leave this field empty.
  5. In the Private Key text field, enter the private key for the user for the SFTP server. If you choose to provide both, then Lytics will try to connect to the SFTP server with the private key first and if that fails then we will try with the password.
  6. In the Passphrase text field, enter the passphrase for the private key you entered if any.
  7. In the Folder text field, enter the relative path to the folder to import or export file. If the path is not given, then we will export the file to the user's home directory. client-sftp-server-auth

Client SFTP Server Authorization with PGP Private Key

This authorization lets you import JSON or CSV files to Lytics that have been encrypted using your PGP private key. In order to add this authorization, please make sure you have your PGP keys set up first. See PGP encryption for more information.

  1. In the Host text field, enter the host name or IP address of the SFTP server you want to connect to.
  2. In the Port text field, enter the port number for the SFTP server.
  3. In the Username text field, enter the username for the SFTP server.
  4. In the Password text field, enter the password for the SFTP server. If you wish to use a Private Key, leave this field empty.
  5. In the Private Key text field, enter the private key for the user for the SFTP server. If you choose to provide both, then Lytics will try to connect to the SFTP server with the private key first and if that fails then we will try with the password.
  6. In the Passphrase text field, enter the passphrase for the private key you entered if any.
  7. In the PGP Private Key text field, enter your PGP private key. See PGP private keys for more information.
  8. In the PGP Private Key Passphrase text field, enter the passphrase for your PGP private key.
  9. In the Folder text field, enter the relative path to the folder to import the file from. If the path is not given, then we will connect to the user's directory. client-sftp-pgp-private

Client SFTP Server Authorization with PGP Public Key

This authorization lets you export Lytics audiences to a CSV file while also encrypting the content using the provided PGP public key. In order to add this authorization, please make sure you have your PGP keys set up first. See PGP encryption for more information.

  1. In the Host text field, enter the host name or IP address of the SFTP server you want to connect to.
  2. In the Port text field, enter the port number for the SFTP server.
  3. In the Username text field, enter the username for the SFTP server.
  4. In the Password text field, enter the password for the SFTP server. If you wish to use a Private Key, leave this field empty.
  5. In the Private Key text field, enter the private key for the user for the SFTP server. If you choose to provide both, then Lytics will try to connect to the SFTP server with the private key first and if that fails then we will try with the password.
  6. In the Passphrase text field, enter the passphrase for the private key you entered if any.
  7. In the PGP Public Key text field, enter PGP public key. See PGP public keys for more information.
  8. In the Folder text field, enter the relative path to the folder to export file to. If the path is not given, then we will connect to the user's directory. client-sftp-pgp-public

Configure Lytics Managed SFTP Authorization

You can also use Lytics managed SFTP server to import or export files to or from Lytics.

The Lytics managed SFTP server URL and port are:

SFTP Host Name: sftp.lytics.io 
SFTP Port Number: 22  

For credentials to connect to Lytics Managed SFTP, you will create it according to your requirements using one of the following ways:

When you add an authorization, Lytics creates a user using the information provided in the Lytics managed SFTP server. You can use those user credentials to upload or download a file.

Lytics Managed SFTP Server Authorization

  1. In the Username text box, enter a username. This username must be between 3 to 32 characters. Username can have characters a-z, A-Z, 0-9, hyphen(-), and underscore(_). It cannot start with hyphen(-).
  2. In the Password password box, enter a password. The password must be between 8 to 32 characters and include at least one uppercase letter, lowercase letter, number and special character. lytics-managed-sftp-auth

Lytics Managed SFTP Server Authorization with PGP Private Key

This authorization lets you import JSON or CSV files that have been encrypted with your PGP private key. In order to add this authorization, please make sure you have your PGP keys set up. See PGP encryption for more information.

  1. Create a user for Lytics managed SFTP server if you have not already.
  2. Use the credentials of that user and Lytics managed SFTP server host details (Host name: sftp.lytics.io Port: 22) to create SFTP Server authorization with PGP Private Key using Client SFTP Server Authorization with PGP Private Key.

Lytics Managed SFTP Server Authorization with PGP Public Key

This authorization lets you export Lytics audiences to a CSV file while encrypting the content using the provided PGP public key. In order to add this authorization, please make sure you have your PGP keys set up. See PGP encryption for more information.

  1. Create a user for Lytics managed SFTP server if you have not already.
  2. Use the credentials of that user and Lytics managed SFTP server host details (Host name: sftp.lytics.io Port: 22) to create SFTP Server authorization with PGP Public Key using Client SFTP Server Authorization with PGP Public Key.