API Key Wildcard: Verwendung
Den Wildcard-Endpoint von API Key Wildcard nutzen: Endpoint-Vergleich, curl-Beispiel, unterstützte Formate, Grenzen gegenüber Endpoints anderer Plugins und Sicherheitshinweise für Entwicklungsumgebungen.
API Key Wildcard: Verwendung
Endpoint-Vergleich
| Standard-API | Wildcard-Endpoint | |
|---|---|---|
| URL | /api/tickets.json |
/api/wildcard/tickets.json |
| IP-Prüfung | Key-IP muss zur Absender-IP passen | Key-IP ist die Absender-IP oder 0.0.0.0 |
| Zweck | Produktion | Entwicklung und Tests |
Der Standard-Endpoint bleibt unverändert und arbeitet weiter mit IP-gebundenen Keys.
Ticket per curl erstellen
curl -X POST \
-H "X-API-Key: DEIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Test User","email":"test@example.com","subject":"Test Ticket via Wildcard","message":"Nachricht über den Wildcard-Endpoint"}' \
http://localhost/osTicket/api/wildcard/tickets.json
Unterstützte Routen
Der Wildcard-Endpoint hat genau eine Route: POST /tickets.json, POST /tickets.xml und POST /tickets.email, jeweils unterhalb von /api/wildcard. Das Ticket wird vom Ticket-Controller von osTicket erstellt, nur die Prüfung des API-Keys ersetzt das Plugin.
| Standard-Endpoint | Wildcard-Endpoint |
|---|---|
/api/tickets.json |
/api/wildcard/tickets.json |
/api/tickets.xml |
/api/wildcard/tickets.xml |
/api/tickets.email |
/api/wildcard/tickets.email |
Andere Methoden und andere Pfade (zum Beispiel Ticket-Abfragen) leitet der Wildcard-Endpoint nicht an die Wildcard-Prüfung weiter. Nutze dafür die Standard-API mit einem IP-gebundenen Key.
Endpoints anderer Plugins
Der Wildcard-Endpoint sendet das Signal api mit seinem Dispatcher, damit andere Plugins Routen anhängen können. Solche Routen prüfen den API-Key mit ihrer eigenen Logik und kennen die Wildcard-Regel nicht. Ein 0.0.0.0-Key gilt dort nicht automatisch für beliebige IPs.
Verhalten bei Fehlern
Die Antworten mit Status 401 und ihre Ursachen findest du unter Fehlerbehebung.
Sicherheitshinweise
Ein Wildcard-Key erlaubt jedem, der den Key kennt, das Erstellen von Tickets von beliebigen IPs aus. Setze ihn nur dort ein, wo das vertretbar ist.
Wildcard-Keys (
0.0.0.0) sind für Entwicklungsumgebungen gedacht. In Produktivumgebungen bindest du jeden Key an eine feste IP.
- Nicht geeignet: öffentlich erreichbare Produktivserver, Systeme mit sensiblen Daten, regulierte Umgebungen.
- Geeignet: lokale Entwicklung, interne Netze hinter einer Firewall, nicht öffentliche Test- und Staging-Umgebungen.
- Getrennte Keys: Verwende für Produktion einen IP-gebundenen Key auf dem Standard-Endpoint und für Entwicklung einen eigenen Wildcard-Key pro Person oder Werkzeug.
- Key verloren: Deaktiviere den Key im Admin Panel, lege einen neuen an und prüfe das System-Log auf Einträge
Wildcard API Key Used.