AccessToken API

概述

AccessToken API是用于管理 Fess API访问令牌的API。 您可以创建、更新、删除令牌等。

基础URL

/api/admin/accesstoken

端点列表

方法 路径 说明
GET/PUT /settings 获取访问令牌列表
GET /setting/{id} 获取访问令牌
POST /setting 创建访问令牌
PUT /setting 更新访问令牌
DELETE /setting/{id} 删除访问令牌

获取访问令牌列表

请求

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

参数

参数 类型 必需 说明
size Integer 否 每页记录数（默认：20）
page Integer 否 页码（从0开始）

响应

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

获取访问令牌

请求

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

响应

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

创建访问令牌

请求

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

请求体

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

字段说明

字段 必需 说明
name 是 令牌名称
token 否 令牌字符串（未指定时自动生成）
parameterName 否 参数名称（默认：”token”）
expiredTime 否 过期时间（Unix时间毫秒）
permissions 否 允许的角色

响应

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

更新访问令牌

请求

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

请求体

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

响应

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

删除访问令牌

请求

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

响应

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

使用示例

创建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"]
     }'

使用令牌调用API

# 使用令牌作为参数
curl "http://localhost:8080/json/?q=test&token=your_token_here"

# 使用令牌作为Authorization头
curl "http://localhost:8080/json/?q=test" \
     -H "Authorization: Bearer your_token_here"

参考信息