Sachpool API¶
Die Sachpool API ist eine PHP-basierte REST-API, öffentlich erreichbar unter:
https://api.sachpool.de
Überblick¶
| Eigenschaft | Wert |
|---|---|
| Basis-URL | https://api.sachpool.de |
| Protokoll | HTTPS (Let's Encrypt) |
| Infrastruktur | PHP, nginx, Ubuntu Server (firmeninternes Netz, öffentlich erreichbar) |
| Primäres Format | JSON (intern) |
| Erweitertes Format | XML nach BiPRO-Standard (geplant) |
| Authentifizierung | API-Key |
Authentifizierung¶
Jeder Request an die API muss mit einem API-Key authentifiziert werden. Der Key wird im HTTP-Header mitgeschickt:
API-Keys werden serverseitig verwaltet und pro Drittsystem vergeben. Secrets/Keys gehören in Vaultwarden – nie in Code oder Doku.
Antwortformat¶
Alle Endpunkte antworten standardmäßig mit JSON:
Für BiPRO-konforme Schnittstellen wird zusätzlich XML unterstützt (siehe BiPRO-Integration).
Endpunkte¶
| Endpunkt | Methode | Beschreibung |
|---|---|---|
/token/validate |
POST |
Login-Token eines Drittsystems prüfen |
Fehlerbehandlung¶
TODO
Einheitliches Fehlerformat (HTTP-Statuscodes, JSON-Fehlerstruktur) noch festzulegen.