Skip to content

Language: English | Türkçe

IQV Integration API

Proprietary ERP integration API for IQVizyon. The service receives project and work-order data from ERP systems, validates and transforms it, and persists accepted data to a customer-local MongoDB deployment.

Documentation version

Current documented version: unreleased. Release target: 1.0.0. Maintain these values in docs/site-meta.yml when a version is published. Do not treat this site as a published GitHub Release.

What is implemented

  • HTTP API: health, optional Client Credentials auth, inbound work orders (JSON/XML), machine events, production performance
  • Idempotency and request archive for live inbound POSTs
  • MongoDB persistence with forward-only migrations
  • CLI: serve, worker, check, migrate, version, service (Windows)
  • Four deployment families: Windows Native, Windows Docker, Linux Native (systemd), Linux Docker

Outbound worker jobs and global health push remain scaffolds / planned. They are not production business features.

Choose a path

Topic Start here
Installation Installation Guide
API Inbound Work Orders
Operations Configuration
Testing Testing Overview
Troubleshooting Troubleshooting
Release model Release Process
Publishing this site Publishing Documentation

Deployment matrix

flowchart TB
  subgraph windows [Windows]
    WN[Native Service]
    WD[Docker Desktop Linux containers]
  end
  subgraph linux [Linux]
    LN[systemd prebuilt binary]
    LD[Docker Engine offline image]
  end
  WN --> Mongo[(External MongoDB)]
  WD --> Mongo
  LN --> Mongo
  LD --> Mongo
Platform Model Production shape today
Windows Native Service Source-tree installer (scripts/windows/service). Recommended Windows production path.
Windows Docker Source-tree / lab installer (scripts/windows/docker). Not an offline prebuilt package yet.
Linux Native systemd Offline prebuilt binary package. No Go/Git on the customer host.
Linux Docker Offline prebuilt OCI image package. No registry pull or docker build on the customer host.

Evidence, not a guarantee

Live lab results are commit-scoped. Automated tests are not a substitute for live E2E. See Live E2E Acceptance.