API Reference Overview

All public REST API endpoints in the ConformaESG Integration Service.

Base URL

Shell

http://localhost:8080

Authentication Headers

Header	Required	Description
`X-API-Key`	✅ all requests	Service authentication
`X-User-Id`	✅ POST / PATCH	Operator ID for audit logging
`Content-Type`	✅ write requests	`application/json`

Response Codes

Code	Meaning
`200 OK`	Success (GET, PATCH)
`201 Created`	Resource created (POST)
`400 Bad Request`	Validation error
`401 Unauthorized`	Missing/invalid API key
`404 Not Found`	Resource not found
`500 Internal Server Error`	Server error

Error Format

JSON
{ "error": "Supplier not found with id: 999" }

Pagination

Param	Type	Default	Description
`page`	integer	`0`	Zero-based page index
`size`	integer	varies	Items per page (see each resource)

Available Resources

Resource	Base Path	Default Size / Max
Suppliers	`/api/suppliers`	50 / 250
Supplier Products	`/api/supplier-products`	—
Company Products	`/api/company-products`	—
Purchase Records	`/api/purchase-records`	—
Chemical Products	`/api/chemicals`	—
Traceability	`/api/traceability`	—
Processing Stages	`/api/processing-stages`	—

Swagger UI

Shell

http://localhost:8080/q/swagger-ui
http://localhost:8080/q/openapi