Skip to main content
Version: 1.0.0

Manufacturing Admin API

API documentation for the Manufacturing Admin service.

API Versioning Strategy​

APIs use individual versioning where each endpoint controls its own version independently. This allows different APIs to evolve at their own pace.

URL Structure: /api/{api-name}/{version}

Example: /api/hello/v1

Features​

Security​

All API endpoints include:

  • Helmet security headers (CSP, HSTS, etc.)
  • CORS support with configurable origins
  • Request ID tracking for debugging

Authentication:

  • Some APIs require API key authentication via X-API-Key header
  • API keys are validated against the API_KEY environment variable

Error Handling​

Consistent error responses across all APIs:

{
  "error": "Not Found",
  "message": "Cannot GET /nonexistent/v1",
  "statusCode": 404,
  "requestId": "unique-request-id"
}

All error responses include:

  • error: Error type (e.g., "Bad Request", "Unauthorized", "Not Found")
  • message: Detailed error description
  • statusCode: HTTP status code
  • requestId: Unique identifier for debugging and tracing