ZincirX ZincirX

Documentation

Quick Start Guide

Welcome to ZincirX! This guide will help you get started with our supply chain traceability platform.

Step 1: Create Your Account

  1. Visit ZincirX and click "Sign Up"
  2. Enter your name and email address
  3. Choose a password of at least eight characters, or sign up with your Google or Facebook account instead
  4. Accept the Terms of Service, the Sales, Delivery and Refund Policy and the Data Processing Terms, and read the Privacy Policy
  5. Sign in with the account you have just created

Step 2: Complete Onboarding

  1. Provide your email address for notifications
  2. Verify your email through the confirmation link
  3. Enter your business information and category
  4. Complete your business profile setup

Step 3: Create Your First Template

  1. Navigate to Templates section
  2. Click "Create New Template"
  3. Define your supply chain process steps
  4. Set validation requirements for each step
  5. Save and activate your template

Step 4: Start Tracking Batches

  1. Go to Batches section
  2. Create a new batch using your template
  3. Execute each step as products move through your supply chain
  4. Upload supporting documentation and media
  5. Share verification links with stakeholders

Core Concepts

Templates

Templates define the standard process for your supply chain. They contain a series of steps that products must go through, along with validation requirements for each step.

  • Reusable workflow definitions
  • Customizable step requirements
  • Role-based access controls
  • Validation rules and dependencies

Batches

Batches represent specific production runs or groups of products following a template. Each batch has a unique UUID for tracking and verification.

  • Unique identification via UUID
  • Step-by-step execution, with the date and time of each step
  • Media and document attachments
  • Public verification capabilities

Batch Steps

Individual steps within a batch execution, each with its own status, timestamps, and supporting documentation.

  • Status tracking (pending, in_progress, completed, failed)
  • Timestamp recording for each status change
  • Location data and GPS coordinates
  • File attachments and notes

Business Profiles

Company information linked to user accounts, enabling multi-party collaboration and role-based access.

  • Company identification and verification
  • Business category classification
  • Contact information and preferences
  • Access permission management

User Roles and Permissions

Role Permissions Typical Use Case
Manufacturer Create templates, start batches, execute all steps Original producers creating and managing products
Distributor Execute specific steps, update locations, add documentation Logistics and distribution companies handling products
Retailer View batch information, execute final steps, customer-facing verification Stores and outlets selling to end consumers
Inspector View all data, add certifications, quality control documentation Regulatory bodies and quality assurance teams
Consumer Public verification via UUID/QR codes End customers viewing a product's recorded journey

API Integration

Authentication

ZincirX uses API token authentication (Laravel Sanctum). To integrate with our API:

  1. Request a token by posting your email address and password to /api/auth/login
  2. Send that token as a bearer token in the Authorization header of each request
  3. Public verification endpoints under /api/public require no token

Key Endpoints

Batch Operations

  • GET /api/batches
  • POST /api/batches
  • GET /api/batches/{id}
  • POST /api/batches/{id}/steps/{stepId}/complete

Template Management

  • GET /api/templates
  • POST /api/templates
  • PUT /api/templates/{id}

Public Verification

  • GET /verify/{uuid}
  • GET /qr/{uuid}/image

Records and Verification

Where Your Data Is Held

  • Storage: ZincirX's own database, on servers we operate
  • Passport revisions: Append-only — a change is recorded as a new revision and earlier ones are kept
  • Evidence files: Each upload carries a SHA-256 fingerprint, so a file can be shown not to have changed
  • Availability: A passport stays reachable for the term sold with it, ten years by default, counted from the day it is issued

Verification Features

Supply chain records are held in ZincirX's own database on its own servers. The platform is built around making those records verifiable by third parties:

  • Template registration, including an optional GTIN for the product
  • Batch creation and step completion records, with timestamps
  • A SHA-256 fingerprint for each uploaded file, so a file can be shown not to have changed
  • Append-only Digital Product Passport revisions: a change is recorded as a new revision and earlier ones are kept

Best Practices

Security

  • Use a strong, unique password for your ZincirX account and never share your sign-in details
  • Review the members of your business regularly and remove access that is no longer needed
  • Check the details of a step and the files attached to it before marking it complete
  • Use strong passwords for your business email account

Data Management

  • Provide accurate and complete information for each step
  • Upload clear, relevant media files for verification
  • Use consistent naming conventions for batches and templates
  • Regularly review and update your business profile

Collaboration

  • Share batch access with relevant supply chain partners
  • Communicate step requirements clearly to all participants
  • Use QR codes for easy verification by end customers
  • Maintain regular communication with your supply chain network

Troubleshooting

Sign-In Issues

  • Check that your email address and password are entered correctly
  • If you registered with Google or Facebook, sign in with the same provider
  • Clear browser cache and cookies
  • Use the password reset link on the sign-in page if you cannot remember your password

Batch and Upload Failures

  • Check that you have prepaid passports (UUIDs) available before creating a batch
  • Ensure network connectivity is stable
  • Wait for a previous upload to finish before starting another
  • Check that each uploaded file is within the size limit shown on the upload form

Performance Issues

  • Use modern browsers (Chrome, Firefox, Safari)
  • Close unnecessary browser tabs and applications
  • Check your internet connection speed
  • Clear browser data and restart if needed

Support and Resources

Community Support

Connect with other ZincirX users and get community-driven support for your questions and challenges.

  • User forums and discussions
  • Best practices sharing
  • Feature requests and feedback

Technical Support

Get direct assistance from our technical team for integration and platform-specific issues.

  • API integration support
  • Digital Product Passport and GS1 Digital Link guidance
  • Custom solution consulting
Get Started Now