Fess API-Leitfaden

Erste Schritte

Einführung

• Zielgruppe
• Bevor Sie beginnen
• Voraussetzungen für die API-Nutzung
• Online-Zugriff
• Kontakt für technischen Support
• Hinweise zu Drittanbieter-Websites
• Übermittlung von Kommentaren und Vorschlägen

API-Schnellstart

• In 5 Minuten starten
• Postman verwenden
• Codebeispiele nach Programmiersprache
• API-Versionskompatibilität
• Fehlerbehebung
• Nächste Schritte

Such-API

API-Übersicht

• Von Fess bereitgestellte APIs
• Basis-URL
• Authentifizierung
• HTTP-Methoden
• Antwortformat
• Fehlerbehandlung
• API-Typen

Such-API

• Abrufen von Suchergebnissen
• Suche in allen Dokumenten
• Fehlerantworten

Label-API

• Abrufen von Labels
• Verwendungsbeispiele
• Fehlerantworten

Beliebte-Wörter-API

• Abrufen beliebter Wörter
• Fehlerantworten

Vorschlags-API

• Abrufen von Vorschlagswörtern
• Fehlerantworten

Health-API

• Abrufen des Status
• Fehlerantworten

Chat API

• Übersicht
• Voraussetzungen
• Nicht-Streaming-API
• Streaming-API
• Fehlerbehandlung
• Rate Limiting
• Sicherheit
• Referenzinformationen

Admin-API

Admin API Referenz

• Admin API Übersicht
• WebConfig API
• FileConfig API
• DataConfig API
• Documents API
• CrawlingInfo API
• FailureUrl API
• Backup API
• Scheduler API
• JobLog API
• User API
• Role API
• Group API
• AccessToken API
• LabelType API
• KeyMatch API
• BoostDoc API
• ElevateWord API
• BadWord API
• RelatedContent API
• RelatedQuery API
• Suggest API
• General API
• SystemInfo API
• Stats API
• Log API
• Storage API
• Plugin API
• Dict API
• SearchLog API