SFTP — как настроить

СОДЕРЖАНИЕ

• SFTP — как настроить
  • Хостинг и аутентификация
  • Настройка
  • Частота и расписание
  • Отчётность и обработка ошибок
    • Связанные вопросы
  • Как создать публичный SSH-ключ для SFTP-сервера
    • Формат
    • Шаблон
    • Создание SSH-ключей 
    • Пример ключа
  • Инструкции для отдельных типов записей

Хостинг и аутентификация

Мы размещаем вашу папку SFTP на отдельном сервере SFTP (на базе AWS). Для каждого клиента создаётся отдельная учётная запись с доступом только к своей папке. Для входа используется аутентификация по ключу. Поэтому вам нужно создать пару ключей (приватный и публичный) и добавить публичный ключ в поле Public Key при настройке папки. Ключ должен быть в формате openSSH RSA . Как создать ключи — смотрите раздел Как создать публичный SSH-ключ для SFTP-сервера ниже.

Настройка

1. Вставьте созданный вами публичный ключ в поле Public Key . При необходимости вы можете изменить Username . Имя пользователя в поле Username должно начинаться с буквы, цифры или нижнего подчёркивания и содержать от 3 до 100 символов. Допускаются буквы, цифры, нижние подчёркивания, символ @, точки и дефисы.

2. Скопируйте значения Username, Spotnana domain URLи Port number и сохраните их в надёжном месте — они понадобятся вашей команде, которая будет настраивать отправку файлов в новую папку. 
   Обратите внимание: После завершения настройки папки SFTP эти данные также можно будет посмотреть в разделе Manage.

3. Укажите адрес(а) электронной почты, на которые вы хотите получать отчёты о загрузках файлов, в поле SFTP email notification . Подробнее — в разделе Отчётность и обработка ошибок ниже.

4. Нажмите Connect.

Когда вы добавите публичный ключ, статус подключения сначала будет Unverified. Такой статус будет отображаться в OBT, пока в папке не появится первый файл. Это может быть как тестовый файл, так и реальный файл HR или файл с пользовательскими полями (обрабатываются только поддерживаемые форматы). Если вы потом измените публичный ключ, статус снова сменится на Unverified и останется таким до получения следующего файла.

Чтобы удалить папку SFTP, нажмите Disconnect. После этого папка будет удалена. Если потребуется создать её заново, все данные придётся ввести с самого начала.

Частота и расписание

Вы сами определяете, как часто и когда загружать файлы. Мы начинаем обработку файла сразу после того, как он появляется в вашей папке на нашем SFTP-сервере. То есть, как только вы загрузили файл — система сразу приступает к его обработке. 

Рекомендации по частоте загрузки для каждого типа записей (например, пользователи, пользовательские поля, юридические лица) смотрите в разделе Частота и расписание в инструкции по SFTP для соответствующего типа записей.

Отчётность и обработка ошибок

Мы собираем информацию о ваших загрузках и после каждой загрузки формируем внутренний отчёт. Этот отчёт отправляется на e-mail, который вы указали в поле SFTP email notification при настройке. Для каждого файла в отчёте будет указано: 

• причины, по которым загрузка файла не удалась (например, неверный формат, отсутствуют названия столбцов и т.д.);

• причины, по которым отдельная строка в файле не была загружена. Частичные обновления мы не делаем — если в строке есть ошибка в каком-либо столбце или не заполнено обязательное поле, эта строка не будет загружена; 

• статус загрузки (ожидает, успешно, ошибка).

Вы можете использовать этот отчёт для поиска и устранения ошибок. Если самостоятельно исправить ошибку не получается — обратитесь в техническую поддержку. 

Связанные вопросы

1. Можно ли загружать инкрементальные файлы, которые содержат только новые или обновлённые записи?

   • Да

2. Нужно ли указывать необязательные столбцы в файле (через SFTP или при ручной загрузке), если вы их не используете?

   • Нет

Как создать публичный SSH-ключ для SFTP-сервера

Воспользуйтесь инструкцией ниже, чтобы создать публичный SSH-ключ, который вы нам предоставите.

Формат

• Тип: строка

• Ограничения по длине: не более 2048 символов.

Шаблон

 ^ssh-rsa\s+[A-Za-z0-9+/]+[=]{0,3}(\s+.+)?\s*$

Создание SSH-ключей 

Чтобы создать SSH-ключи, выполните эту команду в командной строке Windows или в терминале на macOS, Linux или UNIX:

ssh-keygen -t rsa -b 4096 -f key_name

Где 

• -t — тип шифрования

• -b — длина ключа (в битах)

• -f — имя файла ключа

Пример ключа

ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQDDJB9oBRPrBegMDPEQo+HmNDb/jKUJL6q2kQpNNMDjNps9mhhwJ1dP/lOavMitBPAndeXlwaNEm2XbGaSrZtD/tbQTX1HQjP6pacy+Alf8kYBm5QFfl/Z6lGC8qHys10fpRXgYE7UhdSv6VyRqt1gELGFQwVBZ2kJJuBGJF1IRywwvG/h68B8iWU1+6KEWYQoUcT45r3j3otnx4NhhzpTiNgDbMk0ix+kar4/IstobRLcb7rt7FoUerTLNrVDi69DqbsGY5LN+NM8jVx0sPQLRC/ruil8pTHP3k4rDCc7a80+sH4sUTW+mHc7MTqbi/CcyyFAD8h7p6WqxEydOaJjMnvqAbE17BOj0TSxv3HMohTf3skzE7PbzVcjIfHTpFPGxmJkghAYAMi5l9VvAs91IpVylxjqPss3xQQJIZEmQdG2k7zk/UpsUFlmaOj6lCHRicFKCixKekzzm3nFuJvDEklurtydOQjZ8WkPzTSJfZBdKMuMUi0SQ9m9ZAw99t0=

Инструкции для отдельных типов записей

Более подробные инструкции по загрузке определённых типов записей через SFTP смотрите в следующих разделах:

• HR-фиды (пользователи)
• Роли
• Пользовательские поля
• Офисы
• Юридические лица