API-Architektur¶
Systemübersicht¶
╔═══════════════════════════════════════════════════════════════════════╗
║ Internet ║
║ ║
║ ┌────────────────────────┐ ┌──────────────────────────┐ ║
║ │ Sachpool-Portal │ │ Drittsysteme │ ║
║ │ sachpool.de │ │ (Partner, Tools) │ ║
║ │ │ └──────────┬───────────────┘ ║
║ │ ┌──────────────────┐ │ │ Port 443 (HTTPS) ║
║ │ │ MySQL │ │ │ ║
║ │ │ (Portal-DB) │ │ │ ║
║ │ └──────────────────┘ │ │ ║
║ └───────────┬────────────┘ │ ║
║ │ Port 443 (HTTPS) │ ║
╚══════════════╪═════════════════════════════════╪═══════════════════╝
│ API-Key │
└──────────────┬───────────────────┘
│ Port 80 / 443
┌────────────────▼────────────────────────────────────┐
│ Ubuntu Server │
│ api.sachpool.de │
│ │
│ nginx (Port 80/443) · PHP · Let's Encrypt │
│ │
│ Eingehend erlaubt: 22 (SSH), 80 (HTTP), 443 │
│ Kein weiterer eingehender Traffic │
└────────────────────────┬────────────────────────────┘
│ Port 2638 (ausgehend)
╔════════════════════════╪════════════════════════════╗
║ Internes Firmennetz │ ║
║ │ ║
║ ┌───────────────┴─────────────────┐ ║
║ │ │ ║
║ ┌─────▼────────────┐ ┌────────────────▼───┐ ║
║ │ Salia-DB │ │ Salia-DB │ ║
║ │ (Produktiv) │ │ (Test) │ ║
║ │ SQL Anywhere │ │ SQL Anywhere │ ║
║ └──────────────────┘ └────────────────────┘ ║
╚════════════════════════════════════════════════════╝
Netzwerk & Ports¶
| Richtung | Port | Protokoll | Zweck |
|---|---|---|---|
| Eingehend | 22 | SSH | Administration / Deployment |
| Eingehend | 80 | HTTP | Let's Encrypt, Redirect auf HTTPS |
| Eingehend | 443 | HTTPS | API-Traffic |
| Ausgehend | 2638 | TCP | Verbindung zur Salia-DB im Firmennetz |
Kein weiterer ein- oder ausgehender Traffic ist erlaubt.
Datenbanken¶
| Datenbank | Umgebung | Verbindung |
|---|---|---|
| Salia-DB Produktiv | Produktion | Port 2638 ins interne Firmennetz |
| Salia-DB Test | Entwicklung / QA | Port 2638 ins interne Firmennetz |
Komponenten¶
| Komponente | Beschreibung |
|---|---|
| nginx | Reverse Proxy, TLS-Terminierung (Let's Encrypt) |
| PHP | API-Logik, SQL→JSON-Mapping |
| Salia-DB | SQL Anywhere-Datenbank, erreichbar über Port 2638 im internen Firmennetz |
| MySQL (Portal-DB) | Eigene Datenbank des Sachpool-Portals – getrennt von der Salia-DB |
| API-Key | Authentifizierung pro Drittsystem/Client |
Aktuell implementierte Schnittstellen¶
| Endpunkt | Zweck |
|---|---|
POST /token/validate |
Login-Token eines Drittsystems prüfen |
Ausblick: Erweiterung der API¶
Datenbankentlastung von Transconnect¶
Perspektivisch soll der API-Server Datenbankverwaltungsaufgaben übernehmen, die derzeit von Transconnect erledigt werden. Ziel ist es, Transconnect zu entlasten und Datenbankoperationen zentral über die API zu kapseln:
- Einheitliche Zugriffskontrolle auf Datenbankebene
- Versionierbare Schnittstellen statt direkter DB-Verbindungen aus Drittsystemen
- Bessere Nachvollziehbarkeit (Logging, Fehlerbehandlung an einem Ort)
TODO
Konkrete Aufgaben, die von Transconnect auf die API migriert werden sollen, noch festhalten.
BiPRO-Unterstützung¶
Für Partneranbindungen nach Branchenstandard: siehe BiPRO-Integration.