English Version

Zurück zur Übersicht

API Key Wildcard: Installation

Plugin-Dateien bereitstellen

Der Plugin-Ordner muss exakt api-key-wildcard heißen und unter include/plugins/ deiner osTicket-Installation liegen. Der Endpoint lädt seine Hilfsdatei über den fest eingetragenen Pfad include/plugins/api-key-wildcard/api.wildcard.inc.php, ein anderer Ordnername bricht den Endpoint daher.

/pfad/zu/osticket/include/plugins/api-key-wildcard/

ZIP-Download

1. Lade das neueste Release von GitHub Releases herunter.
2. Entpacke die ZIP-Datei.
3. Lade den Ordner api-key-wildcard nach include/plugins/ auf deinen osTicket-Server hoch.

Git Clone

cd /pfad/zu/osticket/include/plugins
git clone https://github.com/markus-michalski/osticket-api-key-wildcard.git api-key-wildcard

Das Plugin braucht weder Composer noch weitere Abhängigkeiten. Der Zielordner api-key-wildcard im Clone-Befehl ist wichtig, weil der Repository-Name sonst einen anderen Ordner erzeugt.

Plugin aktivieren

1. Melde dich im osTicket Admin Panel an.
2. Öffne Verwalten → Plugins.
3. Wähle API Key Wildcard Support und aktiviere das Plugin.

Beim Aktivieren läuft enable() und erledigt der Reihe nach:

• Singleton-Instanz: Das Plugin ist ein Singleton. Gibt es noch keine Instanz, legt enable() automatisch eine aktive Instanz mit dem Plugin-Namen an. Schlägt das fehl, bricht enable() an dieser Stelle ab und liefert die Fehlermeldungen der Instanz-Erstellung zurück.
• Endpoint-Datei: wildcard.php wird aus dem Plugin-Ordner nach api/wildcard.php kopiert und mit chmod 0755 versehen.
• api/.htaccess: Das Plugin ergänzt die Datei um Options -MultiViews und die Wildcard-Rewrite-Regel (Details unten).
• Version: Die Plugin-Version wird als installed_version in der Plugin-Konfiguration gespeichert.

Schlägt ein Schritt fehl, liefert enable() die Fehlermeldungen zurück:

• Source file not found: ...
• Failed to copy wildcard.php to ... Please copy manually.
• Failed to set permissions on ...
• .htaccess file not found at ...
• Failed to add Options -MultiViews to .htaccess
• Failed to add wildcard rewrite rule. Could not find osTicket API rewrite pattern.
• die Fehlermeldungen der Instanz-Erstellung (kommen von osTicket, enable() bricht dann vorzeitig ab)

Was in api/.htaccess geändert wird

Das Plugin ändert ausschließlich api/.htaccess im osTicket-Hauptverzeichnis, nicht die .htaccess im Plugin-Ordner. Die Datei im Plugin-Ordner ist nur eine Referenz.

• MultiViews: Das Plugin ersetzt jedes Vorkommen von RewriteEngine On in der Datei (nicht nur das erste) durch RewriteEngine On, eine Leerzeile, den Kommentar # Disable MultiViews for wildcard endpoint (prevents mod_negotiation) mit zwei Leerzeichen Einrückung und darunter Options -MultiViews, ebenfalls mit zwei Leerzeichen Einrückung. Steht Options -MultiViews schon irgendwo in der Datei, ändert das Plugin an dieser Stelle nichts.
• Wildcard-Regel: Vor dem Standard-API-Block von osTicket (erkannt an zwei Bedingungen !-f/!-d gefolgt von der Bedingung auf .../api im Request-URI) wird die Wildcard-Regel eingefügt:

# Wildcard API endpoint (must come BEFORE the default rule)
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^wildcard/(.*)$ wildcard.php/$1 [L]

# Default API endpoint (standard osTicket)

Steht wildcard/ schon in der Datei, wird die Regel nicht noch einmal eingefügt. Findet das Plugin den Standard-Block nicht, wird die Regel nicht eingefügt und die Fehlermeldung oben ausgegeben.

Das Plugin ändert keine PHP-Dateien von osTicket. Es kopiert wildcard.php nach api/ und ergänzt api/.htaccess.

API-Key mit 0.0.0.0 anlegen

1. Öffne Verwalten → API-Schlüssel.
2. Lege einen neuen API-Schlüssel an.
3. Trage als IP-Adresse 0.0.0.0 ein.
4. Aktiviere Kann Tickets erstellen.
5. Speichere und kopiere den erzeugten Schlüssel.

Nur Keys mit der IP 0.0.0.0 gelten auf dem Wildcard-Endpoint für beliebige Absender-IPs. Ein Key, der an die IP des Aufrufers gebunden ist, wird dort ebenfalls akzeptiert.

Manuelle Installation (Fallback)

Schlägt die automatische Installation fehl (zum Beispiel wegen Dateiberechtigungen), erledigst du die Schritte von Hand.

1. Endpoint-Datei kopieren:

cp /pfad/zu/osticket/include/plugins/api-key-wildcard/wildcard.php /pfad/zu/osticket/api/wildcard.php
chmod 755 /pfad/zu/osticket/api/wildcard.php

2. In api/.htaccess nach RewriteEngine On einfügen:

Options -MultiViews

3. In api/.htaccess vor dem Standard-API-Block einfügen:

RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^wildcard/(.*)$ wildcard.php/$1 [L]

Webserver

Das Plugin automatisiert nur Apache über api/.htaccess (mit aktiviertem mod_rewrite). Setzt du einen anderen Webserver ein, wird .htaccess nicht ausgewertet und du musst die Umleitung selbst einrichten.

• Anfragen an /api/wildcard/<pfad> müssen intern auf /api/wildcard.php/<pfad> umgeleitet werden.
• Der Teil nach wildcard.php muss als PATH_INFO bei PHP ankommen, weil der Endpoint daraus die Route (/tickets.json) bestimmt.

Deaktivieren und Entfernen

Beim Deaktivieren löscht disable() die Datei api/wildcard.php und entfernt die Wildcard-Regel sowie Options -MultiViews aus api/.htaccess. Der Plugin-Ordner bleibt bestehen. Schlägt das Löschen der Datei fehl, wird das nur ins PHP-Error-Log geschrieben, disable() meldet trotzdem Erfolg. Prüfe in diesem Fall, ob api/wildcard.php noch existiert.

Deaktiviere das Plugin, bevor du eine Umgebung produktiv schaltest. Danach existiert der Wildcard-Endpoint nicht mehr.