ZincirX

Documentation

Quick Start Guide

Welcome to ZincirX! This guide will help you get started with our blockchain-based supply chain management platform.

Step 1: Connect Your Wallet

  1. Install MetaMask browser extension if you haven't already
  2. Create or import your wallet
  3. Visit ZincirX and click "Connect Wallet"
  4. Approve the connection in MetaMask
  5. Switch to Scimatic Network (Chain ID: 481) when prompted

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
  • Real-time step execution tracking
  • 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 wallet addresses, 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 verifying product authenticity

API Integration

Authentication

ZincirX uses wallet-based authentication. To integrate with our API:

  1. Sign messages with your wallet private key
  2. Include wallet address in API requests
  3. Verify signatures on the Scimatic network

Key Endpoints

Batch Operations

  • GET /api/batches - List user's batches
  • POST /api/batches - Create new batch
  • GET /api/batches/{id} - Get batch details
  • POST /api/batches/{id}/steps/{stepId}/complete - Complete batch step

Template Management

  • GET /api/templates - List templates
  • POST /api/templates - Create template
  • PUT /api/templates/{id} - Update template

Public Verification

  • GET /verify/{uuid} - Public batch verification
  • GET /qr/{uuid}/image - QR code generation

Blockchain Integration

Scimatic Network

  • Chain ID: 481
  • Network Name: Scimatic
  • Currency: SCI
  • Type: Enterprise blockchain network

Smart Contract Integration

ZincirX operates in hybrid mode, combining traditional database storage with blockchain verification. Key blockchain operations include:

  • Template registration and verification
  • Batch creation and step completion records
  • Immutable audit trails for all operations
  • Multi-signature workflows for critical operations

Best Practices

Security

  • Keep your wallet private keys secure and never share them
  • Regularly backup your wallet and recovery phrases
  • Verify all transaction details before signing
  • 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

Wallet Connection Issues

  • Ensure MetaMask is installed and unlocked
  • Check that you're on the correct network (Scimatic - Chain ID: 481)
  • Clear browser cache and cookies
  • Try disconnecting and reconnecting your wallet

Transaction Failures

  • Check your SCI balance for gas fees
  • Ensure network connectivity is stable
  • Wait for previous transactions to complete
  • Try increasing gas limit if transactions are failing

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
  • Blockchain-specific guidance
  • Custom solution consulting
Get Started Now