Skip to main content

Public API Roadmap

Current State​

Public API v1 is in beta. Shipped endpoints so far:

  • GET /public/v1/products
  • GET /public/v1/products/{product_id}
  • POST /public/v1/quotes
  • GET /public/v1/quotes/{quote_id}
  1. Define a partner-focused API contract for core print workflows.
  2. Narrow and stabilize endpoint set (avoid exposing all internal domain complexity).
  3. Introduce first-class developer credentials and key lifecycle management.
  4. Publish versioning/deprecation policy and changelog.
  5. Add integration sandbox + fixtures.
  6. Publish curated API guides and examples from OpenAPI.

Candidate Public Workflow Scope​

  • Catalog discovery
  • Quote/order creation
  • Artwork upload association
  • Status and shipment tracking
  • Invoice/payment status retrieval

Existing Foundations​

  • OpenAPI generation via Springdoc (org.springdoc:springdoc-openapi-starter-webmvc-ui)
  • Service-account API key auth filter
  • Event/webhook infrastructure already present