Interface strategy
API Reference
The intended public interface is a stable business API—not a wrapper around database tables.
The REST API is a planned product capability. This reference states the contract philosophy and the business resources it will expose.
Design rules
Business concepts
Endpoints represent companies, profiles, indicators, benchmarks, predictions and decision alternatives—not internal tables.
Stable evolution
Protocols may evolve from REST to GraphQL or events without changing the business model.
Traceable output
Important responses include versions, evidence, confidence and assumptions where relevant.
Planned resource groups
| Resource | Purpose |
|---|---|
| Companies & profiles | Retrieve organisational identity, financial history and Digital Twin state. |
| Indicators & benchmarks | Expose observed values, expected values, gaps, peer groups and evidence. |
| Predictions & causal estimates | Return clearly separated forecasts and intervention effects with uncertainty. |
| Decision alternatives | Return comparable alternatives, trade-offs and constraints—never opaque decisions. |
Implementation note: no public production API endpoint is published yet. API contracts will be versioned and documented when the product-engineering track begins.
