Skip to main content
This page describes how to discover and consume the REST API exposed by the running SpurtCommerce v6 application.

API discovery

The repository README describes the API documentation route as /apidoc/ when enabled. .env.example provides APIDOC_ENABLED, APIDOC_ROUTE, SWAGGER_ENABLED, SWAGGER_ROUTE, and SWAGGER_FILE. Use the values in your deployed .env, not assumed defaults.

Base URL

The .env.example includes APP_SCHEMA, APP_HOST, APP_PORT, and APP_ROUTE_PREFIX. Construct the base URL from the active deployment configuration and avoid duplicating the route prefix.

Request conventions

  • Use the HTTP method and content type shown in the generated API specification.
  • Send bearer credentials only to trusted HTTPS origins.
  • Use pagination and filtering parameters only where documented by the endpoint.
  • Treat all client input as untrusted.
  • Preserve response status and application-level success/error indicators.

Endpoint reference policy

The checked-out v6 source and generated API docs are authoritative. This package does not invent route names, payload fields, or sample responses where they cannot be verified. For each endpoint, capture method, full path, authentication, permission, tenant scope, request schema, response schema, side effects, and error cases from the running target release.