updated transit api

2026-09-18 20:08:10 +02:00
parent 1154d1d658
commit f935bbeb8c
9 changed files with 144 additions and 13 deletions
@@ -0,0 +1,53 @@
+# XTransit Domains
+
+This document is the central reference for the public XTransit hostnames.
+Use HTTPS for every public request.
+
+## Public Domains
+
+| Domain                                     | Service       | Purpose                                                                                                                                                                                                                  |
+| ------------------------------------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `https://auth.xtransit.testinstance.nl`    | Auth API      | Driver and administrator login. Issues and validates JWT authentication tokens. Use this domain only for authentication requests such as `POST /login`.                                                                  |
+| `https://transit.xtransit.testinstance.nl` | Transit API   | Transit and schedule data used by the Windows XP driver client, admin UI, and public timetable clients. This includes assigned daily schedules, weekly templates, shifts, bus lines, stops, routes, and timetable views. |
+| `https://error.xtransit.testinstance.nl`   | Error Log API | Central error collection and administration. Services send errors to `POST /error_log`; administrators can inspect them through `GET /error_log`.                                                                        |
+| `https://admin.xtransit.testinstance.nl`   | Admin panel   | Browser-based administration interface for managing bus lines, stops, vehicles, weekly schedules, driver shifts, and error logs.                                                                                         |
+
+## Client Rules
+
+### Windows XP driver client
+
+The XP client must use:
+
+- Auth and login: `https://auth.xtransit.testinstance.nl`
+- Assigned schedules and route stops: `https://transit.xtransit.testinstance.nl`
+
+The XP client must never use the auth domain for transit data.
+
+### Admin UI and public timetable
+
+The admin panel is available at `https://admin.xtransit.testinstance.nl`.
+The admin UI and public timetable use:
+
+- Authentication: `https://auth.xtransit.testinstance.nl`
+- Transit API: `https://transit.xtransit.testinstance.nl`
+- Error logging: `https://error.xtransit.testinstance.nl`
+
+### Backend services
+
+The backend services report errors to:
+
+```text
+https://error.xtransit.testinstance.nl/error_log
+```
+
+The database and internal Docker service name are deployment details and should not
+be exposed as public client URLs. Public clients must use the HTTPS domains above.
+
+## Quick Reference
+
+```text
+auth.xtransit.testinstance.nl    Authentication and JWT tokens
+transit.xtransit.testinstance.nl All transit and schedule data
+error.xtransit.testinstance.nl   Central error logging
+admin.xtransit.testinstance.nl   Browser-based administration panel
+```