ABoro-Soft Helpdesk API – Dokumentation
Diese Dokumentation erklärt die wichtigsten Funktionen der Helpdesk API in einfacher Sprache. Alle Beispiele sind so gestaltet, dass sie leicht verständlich sind.
1. Anmeldung und Token erhalten
URL: /api/v1/auth/login/
Methode: POST
Authentifizierung: Keine erforderlich
Beispiel:
{
"email": "[email protected]",
"password": "password123"
}Antwort:
{
"token": "abc123",
"user": {"username": "john_doe"}
}Merke: Der Token wird später bei jedem API-Aufruf im Header mitgesendet.
2. Abmelden (Logout)
URL: /api/v1/auth/logout/
Methode: POST
Header: Authorization: Token <dein_token>
Antwort:
{"message": "Logged out"}3. Lizenz prüfen
URL: /api/v1/auth/validate-license/
Header: X-License-Key: <dein_schlüssel>
Antwort:
{
"valid": true,
"license_info": {"product": "STARTER", "days_remaining": 245}
}4. Tickets abrufen
URL: /api/v1/tickets/
Methode: GET
Header: Token + Lizenz erforderlich
Optionale Filter:
status→open,resolved, usw.priority→low,medium,high
Beispiel:
GET /api/v1/tickets/?status=open&priority=highAntwort:
{"tickets": [{"id": 1, "title": "Login-Fehler"}]}5. Ticket erstellen
URL: /api/v1/tickets/
Methode: POST
Body:
{
"title": "Dashboard lädt nicht",
"description": "Leere Seite beim Laden",
"priority": "high"
}Antwort:
{"id": 42, "status": "open"}6. Kommentar hinzufügen
URL: /api/v1/tickets/{id}/add_comment/
Methode: POST
Body:
{"content": "Wir arbeiten an der Lösung"}Antwort:
{"id": 18, "content": "Wir arbeiten an der Lösung"}7. Ticketstatus ändern
URL: /api/v1/tickets/{id}/change_status/
Methode: POST
Body:
{"status": "resolved"}Antwort:
{"id": 1, "status": "resolved"}8. Kategorien anzeigen
URL: /api/v1/categories/
Methode: GET
Zeigt alle verfügbaren Ticketkategorien.
Beispielantwort:
[{"id": 1, "name": "Bug Report"}, {"id": 2, "name": "Support"}]9. Statistiken abrufen
URL: /api/v1/stats/
Methode: GET
Antwort:
{"total_tickets": 125, "open_tickets": 23}10. Systemstatus prüfen
URL: /api/v1/health/
Methode: GET
Antwort:
{"status": "healthy", "version": "1.0.0"}Wichtig zu wissen
- Alle API-Aufrufe (außer Login & Health) benötigen Token und Lizenzschlüssel.
- Verwende immer HTTPS.
- Tokens bleiben gültig, bis man sich abmeldet.
© 2025 ABoro-Soft Helpdesk API – Dokumentation