Skip to content

Getting Started Overview

The IQV Integration API is a Go service that integrates ERP project and work-order payloads with a customer-local MongoDB database.

You can do today

  • Build and run the binary locally
  • Serve health endpoints and the inbound work-order API
  • Validate configuration and actor identity with check
  • Run registered MongoDB index migrations with migrate
  • Install Windows Native Service, Linux systemd, Windows Docker, or Linux Docker
  • Start the worker process (scaffold only — no outbound business jobs)

Typical usage

flowchart LR
  ERP[ERP] -->|POST JSON or XML| API[IQV Integration API]
  API --> Mongo[(Customer MongoDB)]
  API --> IQV[IQV platform / domain collections]
  Worker[worker CLI] -.->|planned outbound| External[External APIs]
  1. An ERP posts work orders to POST /api/v1/inbound/work-orders.
  2. The API decodes JSON or XML, validates the contract, resolves tenant and actor, and persists accepted data.
  3. IQV applications read the same customer MongoDB.
  4. Outbound push from worker is not implemented.

Next