概述

接口基准地址复制锚点链接

http://localhost:5678/api

接口鉴权复制锚点链接

在 Header 中添加 Authorization 字段，值为 Bearer {Token}

关于如何获取 Token 详见登录认证接口详见 登录认证接口

响应状态码说明复制锚点链接

返回内容格式复制锚点链接

数据返回格式统一使用 JSON

number<0 | 1>

string

string

boolean | object | string

业务代码说明复制锚点链接

参数传递复制锚点链接

除 GET 请求通过 URL 传递参数外，其它请求方式均通过 Body 传递参数

WebSocket 接口复制锚点链接

基准地址

• ws://localhost:5678

鉴权方式与 HTTP 接口相同

目前有三个接口

• /api/ws 默认通用
• /api/ws/terminal 终端服务
• /api/ws/daemon-log 守护任务实时日志

底层 CLI 通信接口复制锚点链接

基准地址

• http://localhost:5678/api/inner

该系列接口没有写入在文档中，主要负责用于 CLI 与后端的通信，用于实现某些底层功能和管理操作。

与开放接口的区别复制锚点链接

服务端接口（API）允许被开发者使用来拓展业务，但与开放接口（OpenAPI）相比存在一些区别：

1. API 随时可能发生变动并且一般不会在更新公告中说明，需要开发者自行观察并处理
2. API 的传参校验没有 OpenAPI 严格
3. API 会返回后端原生错误，OpenAPI 始终不会

OpenAPI 是面向客户端使用的长期稳定接口，一般不会轻易更改。

接口类别复制锚点链接