SFTP Access Instructions
To access the SFTP ongoing, please enter the following information. Note - password is not required as the Label Insight SFTP site utilizes the SSH key authentication. If this is your first time accessing the Label Insight SFTP, please see the Initial Setup Inputs section below.
- Host: sftp.labelinsight.com
- Username: **____**
- Port: 22
SFTP Delivery Directory Structure
The following represents the basic Label Insight SFTP directory structure. Depending on your submissions and deliveries your actual structure may vary slightly.
deliveries > [delivery folder name]
If JSON format is selected:
- %upc%.json
- %upc%.json
- %upc%.json
Please note if you have selected batching or zipping, your file format will not appear as above
If CSV format is selected:
- attributes.csv
- factPanels.csv
- root.csv
- shelftags.csv
Deliveries: for each delivery licensed from Label Insight, a new folder will be created within the “deliveries” folder. Most customers will only have 1 delivery, although it’s possible to have more than one. If additional folders are created for any reason your account manager will alert you.
In rare instances, the SFTP site may have a different structure. In these cases, our team works closely with you to ensure transparency & alignment. Please contact your account manager with questions.
SFTP JSON File Structure & Updates
⭐ Real Time [Default Setting & Recommended]
By default, data flows in real-time from Label Insight’s system to the SFTP site.
Schedule
While the recommended integration is real-time, we also support scheduled pushes such as daily, weekly, monthly, and more. If you prefer a schedule, the recommended delivery schedule is daily or weekly. We also support bi-weekly and monthly.
⭐ Single JSON Files [Default Setting & Recommended]
By default, products will be delivered in JSON format unzipped one file per product.
Batching
Interested in receiving multiple products in a single JSON file? Let our team know you prefer batches.
Zipping
Interested in receiving multiple JSON files zipped into 1 zip file? Let our team know you prefer zipping.
CSV Files
If your organization prefers to receive CSV files rather than JSON files, this is also supported. CSV Files are able to be scheduled based on your needs, but do not have a delta only option at this time.
Push Events
The following events will trigger an update to the product JSON file within your deliveries folder.
| Event | Description |
|---|---|
| Initial Launch | Pushes will occur on a product-by-product basis. Upon initial launch, we will push all applicable products to your destination |
| New Products | Any new product that falls within the licensing agreement will be sent as soon as it is available. |
| Data Edits | Any update to a licensed product reflected in your schema will result in a push |
| Schema Updates | In the future, should additional data (such as attributes) be licensed, an update to the schema will occur and all impacted products will result in a new push. |
SFTP Assortment Directory Structure
Assortments: Label Insight also allows customers to upload item files to the SFTP, this is particularly relevant for our retail customers. If you are interested in uploading your item file to our SFTP, please contact your account manager. Once setup, you'll see a second directory named "assortments".
When uploading item files to the assortments directory, please ensure you add the file within the numbered folder within the assortments directory. It is your choice whether you upload files overtime with the same name OR if you decide to utilize distinct names through time and/or date stamps. If you decide to maintain the same name overtime, please note we will only see the most recent file you've uploaded.
assortments > ### [assortment id folder name]
Note: If you are submitting multiple distinct item files (i.e. you have 2 + assortments) please contact your account manager who will in turn create multiple assortment IDs and folders for you in accordance with your needs.
Initial Setup Inputs
The following steps must be completed to gain access to Label Insight's SFTP.
User Inputs - For each user who will require access to the SFTP site, please visit Label Insight. Then press your username in the top right corner > Admin > SSH Keys > + ADD SSH KEY. You'll then be asked to provide the following and press "ADD SSH KEY" to save.
- User Name - most often an email address
- Public SSH Key - if you do not yet have SSH keys please see the section below.
SSH Key Generation - Label Insight’s SFTP utilizes SSH Key Authentication. If you already have SSH keys generated please skip this section. If you do not have SSH keys generated, please continue on and follow the instructions below for your operating system:
| System | Instructions |
|---|---|
| Mac or Linux | ◦ Open Terminal ◦ Paste the Following Text and Press Enter: ssh-keygen -t rsa -b 2048 -f my-ssh-key◦ Enter a Passphrase and Press Enter: this acts as a password, but you may leave this blank ◦ Re-Enter the Paraphrase and Press Enter: note this must match the first entry exactly ◦ Close Terminal |
| Windows | ◦ Open cmd.exe ◦ Paste the Following Text and Press Enter: ssh-keygen -t rsa -b 2048 -f my-ssh-key◦ Enter a Passphrase and Press Enter: this acts as a password, but you may leave this blank ◦ Re-Enter the Paraphrase and Press Enter: note this must match the first entry exactly ◦ Close cmd.exe |
If you or your team are still unsure or experiencing difficulties, we’re happy to connect and help you self-generate SSH keys (recommended). For an overview on SSH Keys please read more information here.
SSH Key Authentication Set-Up
If you have already added your SSH key file to your FTP software you may skip this step. If you have not added the key file, please note this is a one-time required initial step and you’ll need to follow the instructions below.
Instructions:
◦ Open FTP Software App, such as Filezilla
◦ Press Edit → Settings → Connection → FTP → SFTP
◦ Click “Add Key File” and Upload the SSH Key File
◦ Filezilla will Convert the Key
◦ Press “Ok”
If you or your team are still unsure or experiencing difficulties, we’re happy to connect and help you add your SSH key authentication. Please note if you utilize software other than Filezilla the instructions may vary slightly. Each FTP software provider will have SSH key instructions online.