Guide de l’API Fess

Introduction

Introduction

• Public visé
• Avant de commencer
• Prérequis pour l’utilisation de l’API
• Accès en ligne
• Contact pour le support technique
• Référence aux sites Web tiers
• Comment envoyer des commentaires et des suggestions

Démarrage rapide de l’API

• Commencer en 5 minutes
• Utilisation avec Postman
• Exemples de code par langage de programmation
• Tableau de compatibilité des versions d’API
• Dépannage
• Prochaines étapes

Spécifications communes

Vue d’ensemble de l’API

• API fournies par Fess
• URL de base
• Enveloppe de réponse
• Réponse d’erreur
• Authentification et session
• Format de streaming
• Types d’API

API de recherche

API de recherche

• Recherche de documents
• Récupération de tous les documents (recherche par défilement / NDJSON)

API des étiquettes

• Récupération des étiquettes
• Exemple d’utilisation
• Réponse d’erreur

API des mots populaires

• Obtention de la liste des mots populaires
• Exemple d’utilisation
• Réponse d’erreur

API de suggestions

• Obtention de la liste des mots suggérés
• Exemple d’utilisation
• Réponse d’erreur

API des requêtes et contenus associés

• Récupération des requêtes associées
• Récupération du contenu associé

Health API

• Récupération de l’état
• Exemple d’utilisation
• Réponse et réponse d’erreur

Authentification et interface

API d’authentification et de session

• Vue d’ensemble
• Informations utilisateur communes (UserPayload)
• Récupération de l’état d’authentification
• Connexion
• Déconnexion
• Changement de mot de passe

API de configuration UI

• Vue d’ensemble
• Récupération de la configuration UI

API des fonctions utilisateur

API des favoris

• Liste des documents favoris
• Récupération de l’état favori d’un document
• Ajout aux favoris

API des clics

• Enregistrement d’un clic

API de cache

• Récupération d’un document en cache

API Chat IA

Chat API

• Vue d’ensemble
• Prérequis
• Authentification et CSRF
• Limite de débit
• POST /chat
• POST /chat/stream
• DELETE /chat/sessions/{session_id}
• Sécurité
• Informations de référence

API d'administration

Reference de l’API d’administration

• Vue d’ensemble de l’API Admin
• API 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