SFTP

Import przez konto SFTP

• import jest dedykowany dla UID
• w celu prawidłowego importu w pliku należy wskazać strukturę oraz przygotować dodatkowy plik w celu mapowania struktury
• [nazwa].csv oraz [nazwa].import muszą być zgodne
• Kodowanie pliku .csv i .import: utf-8 bez BOM
• Pliki nie mogą zawierać znaku x00 (Null)

Poprzez serwer SFTP należy wysyłać do ścieżki /in/import dwa pliki:

• exemple.csv
• exemple.import

Nazwa plików jest dowolna, jednak w obydwu musi być taka sama.

Plik CSV powinien zawierać dane, adresy email oraz cechy do importu. Pierwszy wiersz pliku musi zawierać nagłówki/nazwy pól.

Plik IMPORT powinien zawierać ustawienia tego importu w formacie JSON. Przykładowa struktura może wyglądać w poniższy sposób:

Przykład pliku importu

{
  "import": true,
  "system": "sare",
  "group": 45,
  "overwrite": 2,
  "status": 8,
  "fields": {
    "map": {
      "email": "email",
      "cechaNaglowek": "cecha7",
      "foreignKey": "cecha6"
    },
    "foreign_key": "cecha6"
  },
  "csv": {
    "delimiter": ";"
  },
  "duplicates_handling": "skip",
  "checkSpamtrap": false,
  "add_blocked_addresses_to_group": false,
  "sarescript": {
    "before": "<!--sare sare_group_clear(45); sare-->"
  }
}

Parametry importu

• import: true / false
  • Włączone / wyłączone
• system: sare
  • Wskazujemy system, którego ma dotyczyć import
• group: int
  • Grupa podana jako int (domyślnie 0)
• overwrite:
  • Nadpisywanie adresów (domyślnie 4)
  • Wartości:
    • 0: Nie importuj
    • 1: Nadpisz tylko status
    • 2: Nadpisz tylko importowane dane
    • 3: Nadpisz wszystkie dane (kasuj historię)
    • 4: Nadpisz tylko importowane dane ze zmianą typu
    • 5: Nadpisz importowane dane, wyczyść cechy nieimportowane
• status:
  • Status z jakim mają być importowane adresy (domyślnie 8)
  • Wartości:
    • 2: Wypisany ręcznie
    • 3: Wypisał się
    • 4: Chęć wypisania
    • 5: Zapisany brak weryfikacji
    • 6: Zapisany niepotwierdzony
    • 7: Adres zablokowany
    • 8: Zapisany i potwierdzony
• mail_type:
  • Typ e-maila przypisany do adresów podczas importu. (domyślnie text,HTML)
  • Wartości:
    • text,HTML
    • text

Mapa Pól

• fields.map:
  • Mapa cech adresów (pierwszy wiersz pliku z adresami z cechami zdefiniowanymi w systemie SARE)
• fields.ignore:
  • Tablica nazw pól pliku danych, które mają zostać zignorowane podczas importu
• fields.foreign_key:
  • Nazwa cechy klucza obcego. Musi znajdować się także w polu fields.map lub w nagłówku pliku do importu. Nazwa musi odpowiadać nazwie cechy w systemie. Aby skorzystać z tej opcji, niezbędna jest konfiguracja przez IT

CSV

• csv.delimiter:
  • Znak rozdzielający cechy w pliku z adresami (domyślnie ;)
• csv.enclosure:
  • Znak początku i końca ciągu znaków (domyślnie ")
• csv.escape:
  • Znak ucieczki (domyślnie \\)

Inne Parametry

• autodelete:
  • Wartość 1 oznacza, że pliki po zakończeniu importu mają zostać usunięte z serwera sftp. Wartość 0 oznacza, że pliki mają pozostać na serwerze.
• encrypted:
  • Wartość true oznacza, że mechanizm będzie poszukiwał zaszyfrowanego pliku do importu. Wartość false oznacza import z pliku niezaszyfrowanego.
• sarescript.before:
  • SAREscript wykonywany przed importem (np: wyczyszczenie cech, przeniesienie adresów do innej grupy, czyszczenie grup itp.)
• sarescript.after:
  • SAREscript wykonywany po zakończonym imporcie (np: uzupełnienie cech, przypisanie do grupy, wysłanie newslettera itp.)
• account_id:
  • Identyfikator konta w systemie, do jakiego mają zostać zaimportowane dane. W przypadku posiadania jednego konta parametr niewymagany, w innym przypadku parametr jest przypisywany kolejno do następnych kont włączanych do importu.
• duplicates_handling:
  • Przy imporcie z kluczem obcym, co zrobić z importowanymi danymi, które pasują do więcej niż jednego adresu w bazie SARE:
    • default: importuj wszystkie
    • inna wartość: pomiń
  • (domyślnie default)
• checkSpamtrap:
  • Czy przy imporcie pomijać spamtrapty (domyślnie false)
• add_blocked_addresses_to_group:
  • Czy przy imporcie dodać adresy zablokowane do grupy (domyślnie false)

Zgody

• consent.import:
  • Czy zaktualizować przestrzeń informacyjną (wymagane)
• consent.name:
  • Nazwa przestrzeni informacyjnej (wymagane)
• consent.status:
  • Status przestrzeni (wymagane)
  • Wartości:
    • 1: Brak info
    • 2: Tak
    • 3: Nie

Import jest uruchamiany co 5 minut. Zaimportowane pliki zostają przeniesione do podkatalogu: done

Szyfrowanie Plików

Szyfrowanie Plików do Importu

1. Tworzenie pary kluczy GPG.
2. Klient szyfruje pliki do importu (.csv) przy użyciu otrzymanego klucza publicznego.
3. Klient wysyła zaszyfrowany plik na konto SFTP w Digitree wraz z plikiem konfiguracyjnym.
   • Plik konfiguracyjny zawiera między innymi parametr informujący o tym, że plik importu został zaszyfrowany lub nie:

     "encrypted": true/false

4. Digitree przy użyciu klucza prywatnego rozszyfrowuje otrzymany plik.

Szyfrowanie Plików do Eksportu

1. Klient tworzy parę kluczy GPG i przekazuje klucz publiczny Digitree.
2. Digitree szyfruje pliki do eksportu przy użyciu otrzymanego klucza publicznego.
3. Digitree umieszcza zaszyfrowane pliki na serwerze SFTP Digitree.
4. Klient pobiera plik z serwera SFTP Digitree.
5. Klient rozszyfrowuje pobrany plik za pomocą klucza prywatnego.

Wymiana Kluczy Publicznych w Przypadku Importu i Eksportu

1. Ważność klucza ustala się na okres jednego roku.
2. Klucz przesyłany jest stronie drugiej w formie archiwum zaszyfrowanego hasłem.
   • Hasło do archiwum musi zostać przekazane za pomocą innego medium niż sam plik archiwum (np. SMSem).
3. Digitree zgłasza potrzebę wymiany kluczy minimum 3 tygodnie przed zakończeniem ważności klucza.
4. Każda ze stron przekazuje wymagany klucz publiczny drugiej stronie minimum 2 tygodnie przed zakończeniem ważności klucza.

Uwagi

• Szyfrowany plik może być tylko w formacie .csv