API de BadWord

Vision General

La API de BadWord es para gestionar palabras prohibidas (exclusion de palabras de sugerencia inapropiadas) de Fess. Puede configurar palabras clave que no desea mostrar en la funcion de sugerencias.

URL Base

/api/admin/badword

Lista de Endpoints

Metodo Ruta Descripcion
GET/PUT /settings Obtener lista de palabras prohibidas
GET /setting/{id} Obtener palabra prohibida
POST /setting Crear palabra prohibida
PUT /setting Actualizar palabra prohibida
DELETE /setting/{id} Eliminar palabra prohibida

Obtener Lista de Palabras Prohibidas

Solicitud

GET /api/admin/badword/settings
PUT /api/admin/badword/settings

Parametros

Parametro Tipo Requerido Descripcion
size Integer No Numero de elementos por pagina (predeterminado: 20)
page Integer No Numero de pagina (comienza en 0)

Respuesta

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "badword_id_1",
        "suggestWord": "inappropriate_word",
        "targetRole": "",
        "targetLabel": ""
      }
    ],
    "total": 5
  }
}

Obtener Palabra Prohibida

Solicitud

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

Respuesta

{
  "response": {
    "status": 0,
    "setting": {
      "id": "badword_id_1",
      "suggestWord": "inappropriate_word",
      "targetRole": "",
      "targetLabel": ""
    }
  }
}

Crear Palabra Prohibida

Solicitud

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

Cuerpo de la Solicitud

{
  "suggestWord": "spam_keyword",
  "targetRole": "guest",
  "targetLabel": ""
}

Descripcion de Campos

Campo Requerido Descripcion
suggestWord Si Palabra clave a excluir
targetRole No Rol objetivo (vacio para todos los roles)
targetLabel No Etiqueta objetivo (vacio para todas las etiquetas)

Respuesta

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

Actualizar Palabra Prohibida

Solicitud

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

Cuerpo de la Solicitud

{
  "id": "existing_badword_id",
  "suggestWord": "updated_spam_keyword",
  "targetRole": "guest",
  "targetLabel": "",
  "versionNo": 1
}

Respuesta

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

Eliminar Palabra Prohibida

Solicitud

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

Respuesta

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

Ejemplos de Uso

Excluir Palabra Clave de Spam

curl -X POST "http://localhost:8080/api/admin/badword/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "suggestWord": "spam",
       "targetRole": "",
       "targetLabel": ""
     }'

Palabra Prohibida para Rol Especifico

curl -X POST "http://localhost:8080/api/admin/badword/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "suggestWord": "internal",
       "targetRole": "guest",
       "targetLabel": ""
     }'

Informacion de Referencia