JCJC 错别字检测自定义词典 API 接口文档 2025-05-13

JCJC 错别字检测系统自定义词典接口全面开放。企业用户和个人付费用户都可以使用接口方式管理自定义词典。自定义词典包含：白名单和黑名单两种类型。

也可以登录个人中心，点击左侧边栏导航以 UI 界面的方式维护自定义词典。

截图如下：

黑名单词汇：

基本信息

基础路径: http://api.cuobiezi.net/api/v1/dict
所有接口均使用 POST 方法
所有接口支持 CORS (跨域资源共享)
数据格式: JSON

接口列表

1. 添加单个关键词

添加一个新的关键词到自定义词典中。

接口路径

复制代码

POST /api/v1/dict/single/keyword/add

请求参数

参数名	类型	必填	描述
keyword	string	是	要添加的关键词
category	int	是	1 为白名单 2 为黑名单

请求示例

json 复制代码

{
  "user_name": "one_user",
  "password": "a_good_password",
  "keyword": "人工智能",
  "category": 1,
}

响应参数

参数名	类型	描述
is_ok	bool	true 表示成功
message	string	响应消息

响应示例

json 复制代码

{
  "is_ok": true,
  "message": "添加成功",
}

2. 删除单个关键词

从自定义词典中删除指定的关键词。

接口路径

复制代码

POST /api/v1/dict/single/keyword/delete

请求参数

参数名	类型	必填	描述
user_name	string	是	用户名
password	string	是	密码
keyword	string	否	关键词内容（当无法提供ID时可用）

请求示例

json 复制代码

{
  "id": 1001
}

或

json 复制代码

{
  "user_name": "one_user",
  "password": "a_good_password",  
  "keyword": "人工智能"
}

响应参数

参数名	类型	描述
is_ok	bool	true 表示成功
message	string	响应消息

响应示例

json 复制代码

{
  "is_ok": true,
  "message": "删除成功"
}

3. 查询单个关键词

查询自定义词典中的特定关键词详细信息。

接口路径

复制代码

POST /api/v1/dict/single/keyword/get_one

请求参数

参数名	类型	必填	描述
user_name	string	是	用户名
password	string	是	密码
keyword	string	否	关键词内容

请求示例

json 复制代码

{
  "user_name": "one_user",
  "password": "a_good_password",
  "keyword": "人工智能"
}

响应参数

参数名	类型	描述
is_ok	bool	true 表示成功
message	string	响应消息
data	object	关键词详细信息

响应示例

json 复制代码

{
  "is_ok": true,
  "message": "查询成功",
  "data": {
    "keyword": "人工智能",
    "category": 1,
  }
}

4. 关键词列表查询

分页查询自定义词典中的关键词列表。

接口路径

复制代码

POST /api/v1/dict/single/keyword/list

请求参数

参数名	类型	必填	描述
offset	integer	否	开始页
limit	integer	否	每页数量，默认为20

请求示例

json 复制代码

{
  "user_name": "one_user",
  "password": "a_good_password",
  "offset": 0,
  "limit": 10
}

响应参数

参数名	类型	描述
is_ok	bool	true 表示成功
message	string	响应消息
data	object	返回数据

响应示例

json 复制代码

{
  "is_ok": true,
  "message": "查询成功",
  "data": [
      {
        "keyword": "人工智能",
        "category": 1,        
      },
      {        
        "keyword": "智能家居",       
        "category": 1,
      }
      // 更多数据...
    ]
}

注意事项

所有请求必须使用POST方法
请确保请求头中包含Content-Type: application/json
关键词添加后不可直接修改，需先删除再添加
批量操作请参考批量API文档

也可以通过WEB界面测试 JCJC 错别字检测系统：

JCJC错别字检测系统。

发布日期：2025-05-13