API de AccessToken

Vision General

La API de AccessToken es para gestionar tokens de acceso API de Fess. Puede operar creacion, actualizacion y eliminacion de tokens.

URL Base

/api/admin/accesstoken

Lista de Endpoints

Metodo Ruta Descripcion
GET/PUT /settings Obtener lista de tokens de acceso
GET /setting/{id} Obtener token de acceso
POST /setting Crear token de acceso
PUT /setting Actualizar token de acceso
DELETE /setting/{id} Eliminar token de acceso

Obtener Lista de Tokens de Acceso

Solicitud

GET /api/admin/accesstoken/settings
PUT /api/admin/accesstoken/settings

Parametros

Respuesta

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "token_id_1",
        "name": "API Token 1",
        "token": "abcd1234efgh5678",
        "parameterName": "token",
        "expiredTime": 1735689600000,
        "permissions": ["admin"]
      }
    ],
    "total": 5
  }
}

Obtener Token de Acceso

Solicitud

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

Respuesta

{
  "response": {
    "status": 0,
    "setting": {
      "id": "token_id_1",
      "name": "API Token 1",
      "token": "abcd1234efgh5678",
      "parameterName": "token",
      "expiredTime": 1735689600000,
      "permissions": ["admin"]
    }
  }
}

Crear Token de Acceso

Solicitud

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

Cuerpo de la Solicitud

{
  "name": "Integration API Token",
  "parameterName": "token",
  "permissions": ["user"]
}

Descripcion de Campos

Respuesta

{
  "response": {
    "status": 0,
    "id": "new_token_id",
    "token": "generated_token_string",
    "created": true
  }
}

Actualizar Token de Acceso

Solicitud

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

Cuerpo de la Solicitud

{
  "id": "existing_token_id",
  "name": "Updated API Token",
  "parameterName": "token",
  "expiredTime": 1767225600000,
  "permissions": ["user", "editor"],
  "versionNo": 1
}

Respuesta

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

Eliminar Token de Acceso

Solicitud

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

Respuesta

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

Ejemplos de Uso

Crear Token API

curl -X POST "http://localhost:8080/api/admin/accesstoken/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "External App Token",
       "parameterName": "token",
       "permissions": ["guest"]
     }'

Llamada API Usando Token

# Usar token como parametro
curl "http://localhost:8080/json/?q=test&token=your_token_here"

# Usar token en encabezado Authorization
curl "http://localhost:8080/json/?q=test" \
     -H "Authorization: Bearer your_token_here"

Informacion de Referencia