帮助中心
所有文章
新手指南
使用手册
功能概览
文档管理
首页管理
视频管理
前台站点
数据面板
系统设置
开放接口API
知识库Open API使用说明
功能专题
常见问题
使用手册
开放接口API
知识库Open API使用说明
知识库Open API使用说明
最后更新于 2025/08/29  

前置条件：请求Open API所有接口均需要发送Token参数，请扫码添加官方客服来索取Token

获取知识库所有站点

如果在知识库中创建了多个子站点，可通过此接口获取所有站点。

请求URL

  • https://hapi.moyincloud.com/open/kb/version/list

请求方式

  • GET

参数

参数名

必选

类型

说明

websiteId

是

string

站点ID

token

是

string

token值

返回示例
{
    "code": 0,
    "data": [{
        "id": 106,
        "lan": "zh-CHS",
        "lanName": "中文",
        "name": "主站点",
        "slug": "",
        "websiteDomain": "doc.xxx.com"
    }],
    "desc": "成功",
    "reqId": "725cae0f-3ed2-4ba0-a9ce-9ca83a0f81e4"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
json
返回数据说明

参数名

类型

说明

code

int

0表示获取成功

id

int

子站点ID

lan

String

子站点语言

lanName

String

子站点语言中文

name

String

子站点名称

slug

String

子站点在知识库站点中的路径

websiteDomain

String

知识库域名

获取知识库目录

获取管理后台中知识库的目录树结构。

请求URL

  • https://hapi.moyincloud.com/open/kb/catalog/list

请求方式

  • GET

参数

参数名

必选

类型

说明

websiteId

是

string

站点ID

versionId

是

int

子站点ID

token

是

string

token值

返回示例
{
    "code": 0,
    "data": [{
        "id": "1528968012287295489",
        "docId": "1528968012274712577",
        "catalogName": "三分钟上手知识库",
        "isDirectory": 0,
        "children": [],
        "updateTime": "2025-01-01 00:00:00"
    }, {
        "id": "1526491228970950658",
        "docId": "0",
        "catalogName": "公司介绍",
        "isDirectory": 1,
        "children":[{
            "id": "1544155355129319425",
            "docId": "1544155355108347905",
            "catalogName": "一分钟玩转文档编辑",
            "isDirectory": 0,
            "children": [],
            "updateTime": "2025-01-01 00:00:00"  
        }],
        "updateTime": "2025-01-01 00:00:00"
    }],
    "desc": "成功",
    "reqId": "725cae0f-3ed2-4ba0-a9ce-9ca83a0f81e4"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
json
返回数据说明

参数名

类型

说明

code

int

0表示获取成功

id

String

目录树节点ID

docId

String

如果节点是文档，此处为文档ID；否则为0

catalogName

String

目录树节点标题

isDirectory

int

1代表目录，0代表为文档

children

String

子目录，子目录节点结构与当前节点相同

updateTime

String

更新时间

获取已发布的知识库目录

获取已发布到知识库站点的目录树结构。

请求URL

  • https://hapi.moyincloud.com/open/kb/catalog/release/list

请求方式

  • GET

参数

参数名

必选

类型

说明

websiteId

是

string

站点ID

versionId

是

int

子站点ID

token

是

string

token值

返回示例
{
    "code": 0,
    "data": [{
        "id": "1528968012287295489",
        "docId": "1528968012274712577",
        "catalogName": "三分钟上手知识库",
        "isDirectory": 0,
        "children": [],
        "updateTime": "2025-01-01 00:00:00"
    }, {
        "id": "1526491228970950658",
        "docId": "0",
        "catalogName": "公司介绍",
        "isDirectory": 1,
        "children":[{
            "id": "1544155355129319425",
            "docId": "1544155355108347905",
            "catalogName": "一分钟玩转文档编辑",
            "isDirectory": 0,
            "children": [],
            "updateTime": "2025-01-01 00:00:00"  
        }],
        "updateTime": "2025-01-01 00:00:00"
    }],
    "desc": "成功",
    "reqId": "725cae0f-3ed2-4ba0-a9ce-9ca83a0f81e4"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
json
返回数据说明

参数名

类型

说明

code

int

0表示获取成功

id

String

目录树节点ID

docId

String

如果节点是文档，此处为文档ID；否则为0

catalogName

String

目录树节点标题

isDirectory

int

1代表目录，0代表为文档

children

String

子目录，子目录节点结构与当前节点相同

updateTime

String

更新时间

获取文档详情

获取最新的文档详情。

请求URL

  • https://hapi.moyincloud.com/open/kb/doc/detail

请求方式

  • GET

参数

参数名

必选

类型

说明

websiteId

是

string

站点ID

docId

是

int

文档ID

token

是

string

token值

返回示例
{
    "code": 0,
    "data": {
        "id": "1528968012287295489",
        "title": "三分钟上手知识库",
        "content": "文档内容",
        "updateTime": "2025-01-01 00:00:00"
    },
    "desc": "成功",
    "reqId": "725cae0f-3ed2-4ba0-a9ce-9ca83a0f81e4"
}
1
2
3
4
5
6
7
8
9
10
11
12
json
返回数据说明

参数名

类型

说明

code

int

0表示获取成功

id

String

文档ID

title

String

文档标题

content

String

文档内容，是HTML格式

updateTime

String

更新时间

获取已发布的文档详情

获取已发布到知识库站点的文档详情。

请求URL

  • https://hapi.moyincloud.com/open/kb/doc/release/detail

请求方式

  • GET

参数

参数名

必选

类型

说明

websiteId

是

string

站点ID

docId

是

int

文档ID

token

是

string

token值

返回示例
{
    "code": 0,
    "data": {
        "id": "1528968012287295489",
        "title": "三分钟上手知识库",
        "content": "文档内容",
        "updateTime": "2025-01-01 00:00:00",
        "url": "https://support.xxxx.com/d/1634134070399082498.html"
    },
    "desc": "成功",
    "reqId": "725cae0f-3ed2-4ba0-a9ce-9ca83a0f81e4"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
json
返回数据说明

参数名

类型

说明

code

int

0表示获取成功

id

String

文档ID

title

String

文档标题

content

String

文档内容，是HTML格式

url

String

文档最终发布的网页地址

updateTime

String

更新时间

上一篇
组织架构
下一篇
角色和权限使用指南
本篇目录
获取知识库所有站点
请求URL
请求方式
参数
返回示例
返回数据说明
获取知识库目录
请求URL
请求方式
参数
返回示例
返回数据说明
获取已发布的知识库目录
请求URL
请求方式
参数
返回示例
返回数据说明
获取文档详情
请求URL
请求方式
参数
返回示例
返回数据说明
获取已发布的文档详情
请求URL
请求方式
参数
返回示例
返回数据说明