Repository navigation
API Address
mavrovde edited this page Nov 1, 2026
·
2 revisions
The public address of ViaFrei API: why it gets its own subdomain, and what that costs.
| Address | https://api.viafrei.de |
| Versioning | in the path: https://api.viafrei.de/v1/...
|
| Status | Recommended. Becomes due with the first deployment, after the stack decision ([[Stack Comparison |
- Separate edge rules. Rate limits, CORS, caching and request size limits for the API are set on their own, never mixed with the website's or the MCP server's.
- Cookie isolation. The API never receives the website's cookies or consent state. It authenticates with API keys only.
- Freedom to move. The API can later move to its own server or behind a CDN with a DNS change, without touching the website.
-
Clarity for users. It mirrors
mcp.viafrei.de, so keys, documentation and status pages are easy to tell apart.
A path on the website, viafrei.de/api. It works, but it ties the API to the website's routing, limits and outages, and makes a later move harder. Not chosen.
One DNS record and one TLS certificate. The edge in front of ViaFrei issues and renews certificates automatically.
- Architecture Overview: where the edge sits in front of the API
-
Configuration:
server.public_base_url - API Design: versioning and error types
- Project Status: open decisions
ViaFrei API: a public, keyed, read-only REST API to live German mobility data. Design phase; nothing on these pages is a measurement of a running service. Data on viafrei.de and in every API answer is attributed to its publishers under their licences.
About
Design
- Domain Model
- API Design
- Architecture Overview
- Security and Access Keys
- Rate Limits and Priority
- Performance and Caching
- Configuration
- Observability
Data Model
Technical specification
-
Technical Specification
- Interface
- Scope, Conventions and References
- Protocol
- Common Envelope
- Resource Model
- Endpoints, Places
- Endpoints, Roads
- Endpoints, Energy and Parking
- Endpoints, Public Transport and Accessibility
- Endpoints, Weather Risk, Driving Rules and Composed Features
- Service Endpoints
- Errors
- Authentication and Authorisation
- Rate Limiting, Quotas and Priority
- Data Licensing and Attribution
- Compatibility and Versioning
- OpenAPI Skeleton
- Quality
- Delivery and operations
- Interface
Testing
- Testing Strategy
- Testing and Quality (design summary)
Engineering
Technology choice
- Technology Evaluation
- Architecture: Go
- Architecture: Rust
- Architecture: TypeScript
- Stack Comparison
- Benchmark Plan
Reference