基础和全局
创建于 2024-08-15 / 最近更新于 2024-08-15 /
371
字体:
[默认]
[大]
[更大]
功能介绍
要使用文档系统的接口功能,需要到系统设置中,API设置中,将API状态设置为启用。
API KEY和API Secret请妥善保管,一旦泄露将导致您的文档系统可被第三方恶意修改。
若发现被泄露,请点击生成新的API KEY和Secret按钮。
接口的基础信息
我们为文档系统提供了:文档基础信息创建和基础信息更新、文档首页内容编写、文档内容编写和更新接口。
考虑到接口安全性,文档版本切换,排序和删除的接口没有提供。若您需要使用此部分代码,请参考已开放接口代码,根据对应逻辑编写。
接口全局说明
请求方法
接口根据Restful规则进行编写(可参考开发文档)。目前提供了三个请求类型:
请求方法 | 作用 |
---|---|
GET | 数据读取 |
POST | 数据新建 |
PUT | 数据更新 |
因此,您在调用接口时,请发起对应的请求。
考虑到部分用户运行环境可能不支持PUT请求,对于非GET和POST请求,可以在接口地址后缀加上&method=PUT
并将请求方式改为POST或者GET请求方式来解决。
如:/?m=Doc&a=action&method=PUT
header鉴权
所有接口都通过header存放api key 和 api secret 进行鉴权。请求格式如下:
参数 | 示例值 | 类型 | 默认值 | 是否必填 | 描述 |
---|---|---|---|---|---|
Authorization | base64(key:secret) | string | - | 必填 |
Authorization的组成需要将key和secret进行依次base64转换才可以发送给文档系统。
发送数据格式
文档系统所有接口发送数据都是JSON (raw)。
当然我们也兼容表单编码(x-www-form-urlencoded/form-data)。
返回格式和状态
文档系统API所有返回信息均为JSON。
文档系统API请求成功下,一般只返回0和200状态码。
状态码 | 说明 |
---|---|
0 | 表示接口执行错误,根据返回的msg提示进行后续操作 |
200 | 表示接口执行成功 |
404 | 接口不存在 |
500 | 请求的接口地址异常 |
21 人点赞过