API RelatedQuery

Vue d’ensemble

L’API RelatedQuery permet de gerer les requetes associees dans Fess. Vous pouvez suggerer des mots-cles de recherche associes pour des requetes de recherche specifiques.

URL de base

/api/admin/relatedquery

Liste des endpoints

Methode Chemin Description
GET/PUT /settings Obtention de la liste des requetes associees
GET /setting/{id} Obtention d’une requete associee
POST /setting Creation d’une requete associee
PUT /setting Mise a jour d’une requete associee
DELETE /setting/{id} Suppression d’une requete associee

Obtention de la liste des requetes associees

Requete

GET /api/admin/relatedquery/settings
PUT /api/admin/relatedquery/settings

Parametres

Parametre Type Requis Description
size Integer Non Nombre d’elements par page (par defaut : 20)
page Integer Non Numero de page (commence a 0)

Reponse

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "query_id_1",
        "term": "fess",
        "queries": ["fess tutorial", "fess installation", "fess configuration"]
      }
    ],
    "total": 5
  }
}

Obtention d’une requete associee

Requete

GET /api/admin/relatedquery/setting/{id}

Reponse

{
  "response": {
    "status": 0,
    "setting": {
      "id": "query_id_1",
      "term": "fess",
      "queries": ["fess tutorial", "fess installation", "fess configuration"],
      "virtualHost": ""
    }
  }
}

Creation d’une requete associee

Requete

POST /api/admin/relatedquery/setting
Content-Type: application/json

Corps de la requete

{
  "term": "search",
  "queries": ["search tutorial", "search syntax", "advanced search"],
  "virtualHost": ""
}

Description des champs

Champ Requis Description
term Oui Mot-cle de recherche
queries Oui Tableau des requetes associees
virtualHost Non Hote virtuel

Reponse

{
  "response": {
    "status": 0,
    "id": "new_query_id",
    "created": true
  }
}

Mise a jour d’une requete associee

Requete

PUT /api/admin/relatedquery/setting
Content-Type: application/json

Corps de la requete

{
  "id": "existing_query_id",
  "term": "search",
  "queries": ["search tutorial", "search syntax", "advanced search", "search tips"],
  "virtualHost": "",
  "versionNo": 1
}

Reponse

{
  "response": {
    "status": 0,
    "id": "existing_query_id",
    "created": false
  }
}

Suppression d’une requete associee

Requete

DELETE /api/admin/relatedquery/setting/{id}

Reponse

{
  "response": {
    "status": 0,
    "id": "deleted_query_id",
    "created": false
  }
}

Exemples d’utilisation

Requetes associees pour les produits

curl -X POST "http://localhost:8080/api/admin/relatedquery/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "term": "product",
       "queries": ["product features", "product pricing", "product comparison", "product reviews"]
     }'

Requetes associees pour l’aide

curl -X POST "http://localhost:8080/api/admin/relatedquery/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "term": "help",
       "queries": ["help center", "help documentation", "help contact support"]
     }'

Informations complementaires