¶ API Key Wildcard
Diese Dokumentation beschreibt immer die aktuell veröffentlichte Version.
¶ Überblick
Das Plugin stellt neben der Standard-API von osTicket einen zusätzlichen Endpoint bereit: /api/wildcard/tickets.json (ebenso .xml und .email). Auf diesem Endpoint akzeptiert osTicket API-Keys mit der IP-Adresse 0.0.0.0 von jeder Absender-IP. Der Standard-Endpoint bleibt unverändert.
Ohne dieses Plugin: osTickets API verlangt pro API-Key eine feste IP-Adresse. Bei dynamischen IPs (Home-Office, wechselnde Standorte, CI/CD) musst du den Key ständig anpassen.
Mit diesem Plugin: Ein Key mit der IP
0.0.0.0funktioniert auf dem Wildcard-Endpoint von jeder IP aus. Der Standard-Endpoint prüft weiterhin strikt.
Wildcard-Keys (
0.0.0.0) sind nur für Entwicklungsumgebungen gedacht. In Produktivumgebungen bindest du jeden Key an eine feste IP.
¶ Dokumentation
| Seite | Inhalt |
|---|---|
| Installation | Plugin-Ordner, Aktivierung, Änderungen an api/.htaccess, manuelle Installation, Deaktivierung |
| Konfiguration | Die zwei Felder und das Logging |
| Verwendung | Endpoint, curl-Beispiel, Grenzen, Sicherheitshinweise |
| Technische Details | Ablauf, Klassen, SQL-Prüfung, Auto-Update, Dateistruktur |
| Fehlerbehebung | 404 und 401, Logging, Updates, häufige Fragen |
¶ Funktionen
| Funktion | Beschreibung |
|---|---|
| Separater Endpoint | /api/wildcard/tickets.json, .xml und .email (nur POST), Standard-API unverändert |
| Automatische Installation | Aktivieren kopiert wildcard.php nach api/ und ergänzt api/.htaccess |
| Auto-Update | Beim Start wird die installierte Version mit plugin.php verglichen und die Endpoint-Datei bei Bedarf ersetzt |
| Logging | Optionaler Debug-Eintrag, wenn ein Wildcard-Key benutzt wird |
| Aufräumen | Deaktivieren löscht api/wildcard.php und entfernt die Regeln aus api/.htaccess |
¶ Anforderungen
| Anforderung | Version | Hinweise |
|---|---|---|
| osTicket | 1.18.x | Nutzt die API-Klassen von osTicket |
| PHP | 7.4 oder neuer | Die CI prüft 7.4 bis 8.3 |
| Webserver | Apache mit mod_rewrite |
Die Umleitung wird nur für Apache automatisch eingerichtet |
| Dateirechte | Schreibzugriff auf api/ und api/.htaccess |
Für die automatische Installation |
¶ Lizenz
GNU General Public License v2, kompatibel mit osTicket. Siehe LICENSE.
¶ Support
Fehler und Fragen im Issue Tracker. Gib dabei osTicket-Version, PHP-Version, Webserver, Fehlermeldungen aus den Logs und die Plugin-Version an.