REST API
综述
炎凰数据平台提供一整套基于OpenAPI 3.0的标准REST API接口, 可以方便无缝地和其他平台有效整合。 基于功能，可以划分为以下几个服务模块，各个模块支持单独部署和独立管理。
服务列表
- 认证授权服务
- 登录验证，账户管理，权限管理
- 用户，群组，角色管理
- LDAP集成
- 数据目录服务
- 数据集
- 数据源类型
- 视图
- 物化视图
- 表函数
- 数据服务
- HTTP数据导入端口管理
- API Token管理
- HTTP数据导入
- 文件预览，文件上传
- 查询服务
- 查询任务及结果集
- 即席查询
- 结果集导出
- 查询解析器
- 日期解析器
- 前端服务
- 仪表板管理
- 保存查询
- 查询历史
- 系统信息
- 工作流服务
- 告警管理
- 报表管理
- 许可证服务
- 许可证上传
- 许可证浏览
- 许可证切换
- 许可证删除
API文档格式
炎凰数据平台标准REST API遵从Open API规范，文档基于Swagger工具生成，可以通过在线页面浏览API的详细定义。
参数定义
路径和URL里的参数列表可以在Parameters节中找到相关的定义，包括名称，类型以及示例。
请求内容模式
发送请求的JSON格式，可以在Request Schema中找到相关字段的定义，包括名称，类型，是否必填。 当然，也可以切换到Request Example Value中查看示例值。
返回结果及错误代码
返回结果同样可以在Response节中找到请求成功执行后的状态码和结果格式，API返回状态码列表同时展示了可能的返回错误类型。
错误代码规范
炎凰数据平台的标准REST API定义了统一的API错误返回格式，方便调用方统一的错误处理。
例如：
{
"type": "problems/unauthorized",
"title": "Unauthorized",
"detail": "No authorization token provided.",
"status": 401
}
认证方式
炎凰数据平台遵从JSON Web Token(JWT)规范，基于用户和角色对资源访问进行权限控制。访问API之前需要通过登录验证拿到合法的Token，在成功获取Token之后可以在后续的请求访问中复用，默认的有效期为2小时。