Files
SlpSoftware/aidlc-docs/_shared/reverse-engineering/api-documentation.md
T
SluijsensandClaude Sonnet 5.5 1047c738b5 AI-DLC: inception en ontwerp voor redesign B/E met contactformulier
Requirements, application design (incl. concept-API-contract voor het contactformulier), units en functional design voor U1.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-09 21:06:25 +01:00

27 lines
994 B
Markdown

# API Documentation
## REST APIs (consumed)
### Offerings
- **Method**: GET
- **Path**: `{VITE_API_BASE_URL ?? ''}/api/v1/offerings`
- **Purpose**: package cards for PackagesSection
- **Request**: none
- **Response**: JSON array of `PackageCardData`; contract documented in `aidlc-docs/features/react-frontend/construction/react-frontend-app/functional-design/packages-api-handoff.md`
### Sentry tunnel
- **Method**: POST `/sentry-tunnel` (proxied by nginx; vite dev proxy locally)
## REST APIs (provided by this repo)
None. No contact/form endpoint exists yet; `ContactSection` uses `mailto:`.
## Internal APIs
### useTheme()
- **Methods**: `{ theme: 'red' | 'purple', toggleTheme() }`; throws outside ThemeProvider.
### usePackagesQuery()
- **Return**: TanStack Query result with `data: PackageCardData[]`.
## Data Models
### PackageCardData
- **Fields**: `id, slug, title, description, price, priceNote, features[], ctaLabel, featured?`
- **Validation**: none client-side (trusts API).