Recomendar un fabricante para la zona de marcas de ArchiUp. Rellenar encuesta »
API - import danych produktowych

API - import danych produktowych

Producenci mają do dyspozycji dodatkowe rozwiązanie w postaci automatyzacji dodawania dużej ilości zasobów projektowych przez  import specjalnego pliku csv.

Poniższy dokument zawiera informacje dotyczące przygotowania danych na potrzeby importu produktów do bazy ArchiUp.

1. Format danych. Dane na potrzeby importu muszą być przygotowane w pliku w formacie CSV, którego wzorzec otrzymuje producent. Jeśli produkty podlegają grupowaniu w serie lub kolekcje, należy dodatkowo przygotować osobny plik z danymi kolekcji.
  1. 1. Format pliku grup
   Pola wspierane przy imporcie grup produktów:
     - code – string – unikalny identyfikator grupy produktów,
     - type – enum – typ grupy, możliwe wartości to [collection, series],
     - locale – enum – kod języka, w którym przygotowane są pola name oraz description, możliwe wartości to [de, en, es, fr, pl],
     - name – string – nazwa grupy produktów,
     - description – string – opis grupy produktów,
     - category – enum – kategoria, do której należy grupa produktów (rozdział 1.3 zawiera informacje o możliwych wartościach tego pola),
     - places (niewymagane) – enum (multiple) – miejsca przeznaczenia produktów z grupy (rozdział 1.4 zawiera informacje o możliwych wartościach  tego pola),
     - fabrics (niewymagane) – enum (multiple) – materiały wykonania produktów z grupy (rozdział 1.5 zawiera informacje o możliwych wartościach tego pola),
    - files_url (niewymagane) – string – URL pliku archiwum zawierającego multimedia dotyczące grupy produktów (rozdział 2 zawiera informacje o strukturze archiwum).
 
  1.2. Format pliku produktów
   Pola wspierane przy imporcie produktów:
    - code – string – unikalny identyfikator produktu,
    - group (niewymagane) – string – code grupy produktów, do której należy produkt (zobacz 1.1), puste jeśli program nie należy do żadnej grupy,
    - locale – enum – kod języka, w którym przygotowane są pola name oraz description, możliwe wartości to [de, en, es, fr, pl],
    - name – string – nazwa produktu,
    - description – string – opis produktu,
    - category – enum – kategoria, do której należy produkt (rozdział 1.3 zawiera informacje o możliwych wartościach tego pola) – wartość nie jest wymaga jeśli pole group nie jest puste i wskazuje wcześniej zaimportowaną grupę,
   - places (niewymagane) – enum (multiple) – miejsca przeznaczenia produktu (rozdział 1.4 zawiera informacje o możliwych wartościach tego pola) – jeśli produkt należy do grupy, ostateczne miejsca przeznaczenia będą sumą wartości podanych w tym polu oraz wartości pochodzących z grupy
   - fabrics (niewymagane) – enum (multiple) – materiały wykonania produktów z grupy (rozdział 1.5 zawiera informacje o możliwych wartościach tego pola) – jeśli produkt należy do grupy, ostateczne materiały wykonania będą sumą wartości podanych w tym polu oraz wartości pochodzących z grupy,
    - files_url (niewymagane) – string – URL pliku archiwum zawierającego multimedia dotyczące produktu (rozdział 2 zawiera informacje o strukturze archiwum).

  1.3. Dostępne kategorie
  Lista dostępnych kategorii znajduje się pod adresem  https://archiup.com/pl/product/categories. Pola importu przyjmują wartości ID wymienione przed nazwami kategorii.
Produkty i grupy produktów mogą być przypisanie jedynie do kategorii, które nie posiadają podkategorii.

  1.4. Dostępne miejsca przeznaczenia
   Lista dostępnych miejsc przeznaczenia znajduje się pod adresem https://archiup.com/pl/product/places. Pola importu przyjmują wartości ID wymienione przed nazwami miejsc.

  1.5. Dostępne materiały wykonania   
   Lista dostępnych materiałów wykonania znajduje się pod adresem https://archiup.com/pl/product/fabrics. Pola importu przyjmują wartości ID wymienione przed nazwami kategorii.

2. Struktura pliku archiwum z multimediami 
  Archiwum plików multimedialnych produktów i grup produktów musi mieć następującą strukturę:
    - photos (tylko produkt) – zdjęcia produktu; pierwsze zdjęcie w porządku alfabetycznym będzie ustawione jako główne,
    - models (tylko produkt) – modele BIM/CAD,
    - textures – tekstury produktu/grupy,
    - materials – materiały produktu/grupy,
    - additional_resources – zasoby dodatkowe, podzielone na podkatalogi w następującej strukturze:
        - bim – pliki BIM,
        - catalogs – katalogi produktów w formacie PDF,
        - certifications – certyfikaty produktów,
        - instructions – instrukcje użytkowania,
        - technical-drawings – rysunki techniczne,
        - other-resources – inne pliki nie pasujące do żadnej z powyższych kategorii.

Alternatywnie pliki mogą być przygotowane w jednym archiwum, podzielone na podkatalogi nazwane zgodnie z wartościami pola code produktów/grup w pliku CSV.

3. Reguły kodowania danych
  Formatowanie pliku CSV podlega następującym regułom:
   - pliki muszą być przygotowane w kodowaniu UTF-8,
   - poszczególne pola muszą być rozdzielone znakiem ';' (średnik),
   - wartości tekstowe muszą być zamknięte z obu końców znakami '“' (cudzysłów podwójny),
   - podwójne cudzysłowy będące częścią wartości tekstowych muszą być poprzedzone znakiem '\' (backslash),
   - wartości wielokrotne (multiple) muszą być rozdzielone znakiem ',' (przecinek),
   - archiwa plików multimedialnych muszą być w formacie nieszyfrowanych, niezabezpieczonych hasłem plików ZIP.