Skip to main content
Version: 1.0.0

Arvist API

Welcome to the Arvist API 👋

The API is now organized by feature domains for better clarity and maintainability:

  • Auth - User authentication and password management
  • Admin - System administration (logs, system info, cameras)
  • Integrations - External system integrations (sync)
  • Locations - Physical locations, areas, cameras, zones, and quality stations
  • Modules - Feature module management
  • Productivity - Worker productivity tracking and asset management
  • Quality - Quality inspection (shipment inspection, damages, labels, cycle counting)
  • Roles - Role-based access control (RBAC)
  • Safety - Safety compliance (incidents, safety AI reports, ergonomics, case studies)
  • Settings - Application configuration and presets
  • System - System health checks, connectivity status, and application logging
  • Users - User account management

Base Path​

All API routes are prefixed with /v1/api/

Authentication​

  • All routes require authentication unless specified otherwise.
  • M2M routes require:
    • API key authentication as a bearer token matching token in .auth file.
    • Matching scope key for the accessed resource stored in .auth file.
  • Browser access requires:
    • Session-based authentication using httpOnly cookies. No bearer token required.
    • The user must be logged in and have the required permissions.