Dokumentacja
Krótki przewodnik
Witamy w ZincirX! Ten przewodnik pomoże Państwu rozpocząć pracę z naszą platformą identyfikowalności w łańcuchu dostaw.
Krok 1: Utworzenie konta
- Wejść na stronę ZincirX i kliknąć „Zarejestruj się”
- Wpisać imię i nazwisko oraz adres e-mail
- Wybrać hasło składające się z co najmniej ośmiu znaków albo zarejestrować się za pomocą konta Google lub Facebook
- Zaakceptować Regulamin, Politykę sprzedaży, dostawy i zwrotów oraz Warunki powierzenia przetwarzania danych, a także zapoznać się z Polityką prywatności
- Zalogować się na właśnie utworzone konto
Krok 2: Ukończenie wdrożenia
- Podać adres e-mail do powiadomień
- Potwierdzić adres e-mail za pomocą linku potwierdzającego
- Wprowadzić dane i kategorię firmy
- Dokończyć konfigurację profilu firmy
Krok 3: Utworzenie pierwszego szablonu
- Przejść do sekcji Szablony
- Kliknąć „Utwórz nowy szablon”
- Zdefiniować etapy procesu w łańcuchu dostaw
- Określić wymagania walidacyjne dla każdego etapu
- Zapisać i aktywować szablon
Krok 4: Rozpoczęcie śledzenia partii
- Przejść do sekcji Partie
- Utworzyć nową partię na podstawie szablonu
- Wykonywać kolejne etapy w miarę przemieszczania się produktów w łańcuchu dostaw
- Przesłać dokumentację uzupełniającą i pliki multimedialne
- Udostępniać linki weryfikacyjne interesariuszom
Podstawowe pojęcia
Szablony
Szablony określają standardowy proces w Państwa łańcuchu dostaw. Zawierają szereg etapów, przez które muszą przejść produkty, wraz z wymaganiami walidacyjnymi dla każdego etapu.
- Definicje przepływów pracy wielokrotnego użytku
- Konfigurowalne wymagania etapów
- Kontrola dostępu oparta na rolach
- Reguły walidacji i zależności
Partie
Partie to konkretne serie produkcyjne lub grupy produktów realizowane według szablonu. Każda partia ma niepowtarzalny UUID służący do śledzenia i weryfikacji.
- Niepowtarzalna identyfikacja za pomocą UUID
- Realizacja etap po etapie, z datą i godziną każdego etapu
- Załączniki multimedialne i dokumenty
- Możliwość publicznej weryfikacji
Etapy partii
Poszczególne etapy w ramach realizacji partii, każdy z własnym statusem, znacznikami czasu i dokumentacją uzupełniającą.
- Śledzenie statusu (pending, in_progress, completed, failed)
- Rejestrowanie znacznika czasu przy każdej zmianie statusu
- Dane lokalizacji i współrzędne GPS
- Załączniki plikowe i notatki
Profile firm
Informacje o firmie powiązane z kontami użytkowników, umożliwiające współpracę wielu stron i dostęp oparty na rolach.
- Identyfikacja i weryfikacja firmy
- Klasyfikacja kategorii działalności
- Dane kontaktowe i preferencje
- Zarządzanie uprawnieniami dostępu
Role i uprawnienia użytkowników
| Rola | Uprawnienia | Typowe zastosowanie |
|---|---|---|
| Producent | Tworzenie szablonów, rozpoczynanie partii, wykonywanie wszystkich etapów | Pierwotni producenci tworzący produkty i zarządzający nimi |
| Dystrybutor | Wykonywanie określonych etapów, aktualizowanie lokalizacji, dodawanie dokumentacji | Firmy logistyczne i dystrybucyjne obsługujące produkty |
| Sprzedawca detaliczny | Przeglądanie informacji o partii, wykonywanie końcowych etapów, weryfikacja dla klientów | Sklepy i punkty sprzedaży obsługujące konsumentów końcowych |
| Inspektor | Wgląd we wszystkie dane, dodawanie certyfikatów, dokumentacja kontroli jakości | Organy regulacyjne i zespoły zapewnienia jakości |
| Konsument | Publiczna weryfikacja za pomocą UUID/kodów QR | Klienci końcowi przeglądający zapisaną drogę produktu |
Integracja z API
Uwierzytelnianie
ZincirX korzysta z uwierzytelniania tokenami API (Laravel Sanctum). Aby zintegrować się z naszym API:
- Uzyskać token, wysyłając adres e-mail i hasło metodą POST na /api/auth/login
- Przesyłać ten token jako token typu bearer w nagłówku Authorization każdego żądania
- Publiczne punkty końcowe weryfikacji w /api/public nie wymagają tokenu
Najważniejsze punkty końcowe
Operacje na partiach
GET /api/batchesPOST /api/batchesGET /api/batches/{id}POST /api/batches/{id}/steps/{stepId}/complete
Zarządzanie szablonami
GET /api/templatesPOST /api/templatesPUT /api/templates/{id}
Publiczna weryfikacja
GET /verify/{uuid}GET /qr/{uuid}/image
Zapisy i weryfikacja
Gdzie przechowywane są Państwa dane
- Przechowywanie: Własna baza danych ZincirX na obsługiwanych przez nas serwerach
- Wersje paszportu: Wyłącznie dopisywanie — zmiana jest zapisywana jako nowa wersja, a wcześniejsze są zachowywane
- Pliki dowodowe: Każdy przesłany plik ma odcisk cyfrowy SHA-256, dzięki czemu można wykazać, że plik się nie zmienił
- Dostępność: Paszport pozostaje dostępny przez okres sprzedany wraz z nim — domyślnie dziesięć lat — liczony od dnia jego wydania
Funkcje weryfikacji
Zapisy dotyczące łańcucha dostaw są przechowywane we własnej bazie danych ZincirX na jej własnych serwerach. Platforma została zbudowana tak, aby strony trzecie mogły te zapisy weryfikować:
- Rejestracja szablonów, w tym opcjonalny GTIN produktu
- Zapisy utworzenia partii i ukończenia etapów, ze znacznikami czasu
- Odcisk cyfrowy SHA-256 każdego przesłanego pliku, dzięki czemu można wykazać, że plik się nie zmienił
- Wersje cyfrowego paszportu produktu wyłącznie dopisywane: zmiana jest zapisywana jako nowa wersja, a wcześniejsze są zachowywane
Dobre praktyki
Bezpieczeństwo
- Używać silnego, unikalnego hasła do konta ZincirX i nigdy nie udostępniać swoich danych logowania
- Regularnie przeglądać listę członków firmy i odbierać dostęp, który nie jest już potrzebny
- Przed oznaczeniem etapu jako ukończonego sprawdzić jego szczegóły i dołączone do niego pliki
- Używać silnych haseł do firmowego konta e-mail
Zarządzanie danymi
- Podawać dokładne i kompletne informacje dla każdego etapu
- Przesyłać czytelne, odpowiednie pliki multimedialne do weryfikacji
- Stosować spójne konwencje nazewnictwa partii i szablonów
- Regularnie przeglądać i aktualizować profil firmy
Współpraca
- Udostępniać partie odpowiednim partnerom w łańcuchu dostaw
- Jasno przekazywać wymagania dotyczące etapów wszystkim uczestnikom
- Korzystać z kodów QR, aby ułatwić weryfikację klientom końcowym
- Utrzymywać regularny kontakt z siecią partnerów w łańcuchu dostaw
Rozwiązywanie problemów
Problemy z logowaniem
- Sprawdzić, czy adres e-mail i hasło zostały wpisane poprawnie
- W przypadku rejestracji przez Google lub Facebook logować się za pomocą tego samego dostawcy
- Wyczyścić pamięć podręczną i pliki cookie przeglądarki
- Skorzystać z linku do resetowania hasła na stronie logowania, jeśli nie pamiętają Państwo hasła
Błędy partii i przesyłania plików
- Przed utworzeniem partii sprawdzić, czy dostępne są opłacone z góry paszporty (UUID)
- Upewnić się, że połączenie sieciowe jest stabilne
- Poczekać na zakończenie poprzedniego przesyłania przed rozpoczęciem kolejnego
- Sprawdzić, czy każdy przesyłany plik mieści się w limicie rozmiaru podanym w formularzu przesyłania
Problemy z wydajnością
- Korzystać z nowoczesnych przeglądarek (Chrome, Firefox, Safari)
- Zamknąć niepotrzebne karty przeglądarki i aplikacje
- Sprawdzić szybkość połączenia internetowego
- W razie potrzeby wyczyścić dane przeglądarki i uruchomić ją ponownie
Wsparcie i materiały
Wsparcie społeczności
Mogą Państwo nawiązać kontakt z innymi użytkownikami ZincirX i uzyskać od społeczności pomoc w kwestii pytań i wyzwań.
- Fora użytkowników i dyskusje
- Dzielenie się dobrymi praktykami
- Propozycje funkcji i opinie
Wsparcie techniczne
Bezpośrednia pomoc naszego zespołu technicznego w kwestiach integracji i problemach związanych z platformą.
- Wsparcie w integracji z API
- Wskazówki dotyczące cyfrowego paszportu produktu i GS1 Digital Link
- Doradztwo w zakresie rozwiązań dostosowanych do potrzeb