# 语雀 语雀使用了结构化知识库管理，形式上类似书籍的目录。来从源头上帮助用户建立起知识管理的意识，培养良好的知识管理习惯。 #### 连接参数 语雀连接器使用token认证，创建连接时连接参数说明如[表1]所示。 表1连接参数说明 | 名称 | 必填 | 说明 | 示例值/默认值 | |:---|:---|:---|:---| | 连接名称 | 是 | 设置连接名称。 | 语雀 | | 描述 | 否 | 对于连接的信息描述说明。 | description。 | | X-Auth-Token | 是 | Token。 | 1. 登录后，注册账号并登录。 2. 进入个人设置页面，单击"账户设置"进入。 3. 选择"Token"后，显示暂无Token。 4. 单击"新建"，输入Token的用途，选择授权范围。 5. 单击"创建"，Token创建完成。 6. 单击刚创建的Token用途名称进入，从Access Token获取所需要的Token。 更详细的信息，请参见[开发者文档](https://www.yuque.com/yuque/developer/api)。 | #### 创建文档 创建语雀文档。 - 输入参数 输入参数说明如[表2]所示。 表2创建文档输入参数说明 | 参数 | 必填 | 说明 | |:---|:---|:---| | 文档标题 | 是 | 文档的标题。 | | 文档格式 | 是 | 文档的格式。支持输入框和下拉列表两种模式。 - markdown - lake - html | | 文档内容 | 是 | 文档的内容。 | - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见[表3]。 表3创建文档输出参数说明 | 参数 | 说明 | |:---|:---| | 创建后文档信息 | 创建后的文档信息。 | | -文档ID | 文档ID。 | | -文档标题 | 创建的文档标题。 | | -知识库ID | 创建的文档的知识库ID。 | | -文档内容 | 创建的文档内容。 | | -转换过后的正文HTML | 转换过后的正文HTML。 | | -语雀lake格式正文 | 语雀lake格式正文。 | | -是否公开 | 创建的文档是否公开。 | #### 获取文档 - 输入参数 该执行动作无需输入参数。 - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见[表4]。 表4获取文档输出参数说明 | 参数 | 说明 | |:---|:---| | 文档列表 | 文档列表。 | | -文档ID | 文档ID。 | | -文档标识符 | 文档标识符。 | | -文档名称 | 获取的文档名称。 | | -描述 | 文档描述。 | | -所属的团队/用户编号 | 文档所属的团队/用户编号。 | | -知识库ID | 获取文档的知识库ID。 | | -正文格式 | 正文格式。 | | -是否公开 | 文档是否公开。 | | -文档状态 | 文档状态。 | | -最后编辑人ID | 文档最后编辑人ID。 | | -字数统计 | 字数统计。 | #### 获取知识库详情 根据知识库ID获取知识库详情。 - 输入参数 该执行动作无需输入参数。 - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见[表5]。 表5获取知识库详情输出参数说明 | 参数 | 说明 | |:---|:---| | 知识库详情 | 知识库详情。 | | -知识库ID | 知识库ID。 | | -知识库类型 | 知识库类型。 | | -知识库名称 | 知识库名称。 | | -用户ID | 用户ID。 | | -描述 | 文档描述。 | | -创建者ID | 知识库的创建者ID。 | | -是否公开 | 知识库是否公开。 | | -内容总数 | 知识库的内容总数。 | | -点赞总数 | 知识库的点赞总数。 | | -关注总数 | 知识库的关注总数。 | | -命名空间 | 知识库的命名空间。 | | -用户详情 | 知识库的用户详情。 | | -创建时间 | 知识库的创建时间。 | | -更新时间 | 知识库的更新时间。 | #### 获取文档详情 - 输入参数 该执行动作无需输入参数。 - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见[表6]。 表6获取文档详情输出参数说明 | 参数 | 说明 | |:---|:---| | 文档详情 | 文档详情。 | | -文档ID | 文档ID。 | | -文档路径 | 文档路径。 | | -标题 | 标题。 | | -知识库ID | 知识库ID。 | | -正文内容 | 正文内容。 | | -草稿Markdown | 草稿Markdown。 | | -转换过后的正文HTML | 转换过后的正文HTML。 | | -语雀lake格式的文档内容 | 语雀lake格式的文档内容。 | | -点赞总数 | 文档的点赞总数。 | | -累计评论 | 文档的累计评论。 | | -字数统计 | 文档的字数统计。 | | -文档描述 | 文档描述。 | #### 更新文档 更新指定文档标题或内容。 - 输入参数 输入参数说明如[表7]所示。 表7更新文档输入参数说明 | 参数 | 必填 | 说明 | |:---|:---|:---| | 文档标题 | 否 | 输入新的文档标题。 | | 文本内容 | 否 | 输入新的文本内容。 | - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见[表8]。 表8更新文档输出参数说明 | 参数 | 说明 | |:---|:---| | 更新后文档信息 | 更新后的文档信息。 | | -文档ID | 文档ID。 | | -更新后标题 | 文档更新后标题。 | | -知识库ID | 更新的文档的知识库ID。 | | -文档内容 | 更新后的文档内容。 | | -语雀lake格式 | 语雀lake格式。 | #### 获取用户信息 获取当前登录用户的基本信息。 - 输入参数 该执行动作无需输入参数。 - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见[表9]。 表9获取用户信息输出参数说明 | 参数 | 说明 | |:---|:---| | 返回信息 | 返回的用户信息。 | | -用户ID | 用户ID。 | | -用户类型 | 用户类型。 | | -空间ID | 用户空间ID。 | | -账户ID | 用户的账户ID。 | | -登录名 | 用户的登录名。 | | -用户名 | 用户名。 | | -头像url地址 | 用户头像url地址。 | | -粉丝总数 | 用户的粉丝总数。 | | -关注总数 | 用户的关注总数。 | | -创建时间 | 用户的创建时间。 | | -更新时间 | 用户的更新时间。 | #### 获取知识库 获取用户下的知识库列表。 - 输入参数 该执行动作无需输入参数。 - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见[表10]。 表10获取知识库输出参数说明 | 参数 | 说明 | |:---|:---| | 知识库信息 | 知识库信息。 | | -知识库ID | 知识库ID。 | | -知识库类型 | 知识库类型。 | | -知识库名称 | 知识库名称。 | | -用户ID | 用户ID。 | | -知识库描述 | 知识库描述。 | | -知识库创建人ID | 知识库创建人ID。 | | -内容更新时间 | 知识库的内容更新时间。 | | -用户信息 | 用户信息。 | #### 删除指定文档 - 输入参数 该执行动作无需输入参数。 - 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见[表11]。 表11删除指定文档输出参数说明 | 参数 | 说明 | |:---|:---| | 删除的文档信息 | 删除的文档信息。 | | -指定的文档ID | 指定的文档ID。 | | -指定的知识库ID | 指定的知识库ID。 |