SFTP — Інструкція з налаштування

ЗМІСТ

• SFTP — Інструкція з налаштування
  • Розміщення та автентифікація
  • Налаштування
  • Частота та розклад
  • Звіти та обробка помилок
    • Пов’язані питання та відповіді
  • Як створити публічний SSH-ключ для SFTP-сервера
    • Формат
    • Шаблон
    • Створення SSH-ключів 
    • Приклад ключа
  • Інструкції для окремих типів записів

Розміщення та автентифікація

Ми розміщуємо вашу SFTP-папку на окремому SFTP-сервері (AWS). Кожен клієнт отримує унікальний обліковий запис користувача з прямим доступом лише до своєї папки. Для входу використовується автентифікація за ключем. Тому вам потрібно створити пару ключів (відкритий і закритий) та вказати відкритий ключ у полі Public Key під час налаштування папки. Ключ має бути у форматі openSSH RSA . Як створити ключі, дивіться у розділі Як створити публічний SSH-ключ для SFTP-сервера нижче.

Налаштування

1. Вкажіть створений вами відкритий ключ у полі Public Key . За потреби ви також можете змінити значення у полі Username . Значення в полі Username має починатися з літери, цифри або підкреслення та містити від 3 до 100 символів. Дозволяються літери, цифри, підкреслення, символ @, крапка (.) та дефіс (-).

2. Скопіюйте Username, адресу домену Spotnanaта номер порту у безпечне місце — ці дані знадобляться команді у вашій організації, яка налаштовуватиме передачу файлів у нову папку. 
   Примітка: Після завершення налаштування SFTP-папки ці дані можна буде знову переглянути у розділі Керування.

3. У полі SFTP email notification вкажіть електронну адресу (або кілька адрес), на яку ви хочете отримувати звіти про завантаження файлів. Детальніше дивіться у розділі Звіти та обробка помилок нижче.

4. Натисніть Connect.

Після додавання відкритого ключа початковий статус буде Unverified. Саме цей статус відображатиметься в OBT, доки у папці не з’явиться перший файл. Це може бути тестовий файл або реальний HR-фід чи файл із власними полями (обробляються лише підтримувані формати). Якщо пізніше відкритий ключ буде оновлено, статус знову стане Unverified і залишатиметься таким до надходження наступного файлу.

Щоб видалити свою SFTP-папку, натисніть Disconnect. Папку буде видалено. Якщо згодом потрібно буде створити її знову, доведеться вводити всі дані заново, як описано вище.

Частота та розклад

Ви самостійно визначаєте, як часто та у який час завантажувати файли. Обробка файлів запускається одразу після їхнього завантаження на SFTP-сервер — як тільки файл з’являється у вашій папці, система починає його обробку. 

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

Звіти та обробка помилок

Ми збираємо інформацію про ваші завантаження файлів і формуємо внутрішній звіт після кожного завантаження. Цей звіт надсилається на електронну адресу(и), вказану у полі 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-фіди (користувачі)
• Ролі
• Власні поля
• Офіси
• Юридичні особи