API 管理
定义
本模块用于统一管理平台内外部 API 服务，支持通过图形化向导或 SQL 编写的方式快速创建数据服务接口，并具备服务转发、地理空间服务支持等能力，满足多样化数据开放与共享需求。
API 创建模式
- 🪄 向导式配置：通过图形化流程引导用户完成数据源选择、字段配置、输出格式、权限设置等，无需编写代码即可快速创建 API；
- 💻 SQL 模式：支持用户直接编写 SQL 查询语句构建数据服务，适用于复杂业务逻辑与灵活的数据抽取；
- 📌 补充属性：支持设置 API 的更新周期、更新时间、服务描述、访问权限等补充信息，便于服务管理与监控。
第三方服务转发与接入
- 🌐 通用服务转发：支持接入并转发下级地州流域机构开发的第三方 API；
注意事项
发布 API 前请确认数据源权限与敏感字段处理情况，第三方转发服务建议配置限流与鉴权策略，避免接口滥用或泄露。
作用范围
适用于平台内数据的对外服务封装、第三方系统服务的统一接入与转发、地理与视频服务的集成管理等场景，赋能政府、行业、企业数据的服务化输出与统一调用。
1、API管理页面
点击【数据服务】下的【API管理】，进入API管理页面。分为左右两侧，左侧展示树形API服务类目，右侧展示列表包含API名称、API类目、API版本、API路径等字段。
2、新增API服务
点击页面中【新增】按钮，在出现的弹出框内填写API服务信息，并点击【确定】按钮，完成API服务信息新增。
2.1、属性配置
进入新增API服务页面，在【属性配置】模块，填写API名称、API版本等相关信息后，点击【下一步】按钮，进入【参数配置页面】。
2.2、参数配置
进入参数配置页面，选择配置方式，数据源配置包含单表向导式、SQL脚本式、第三方转发三种方式，并填写参数信息后，点击【下一步】按钮，进入【测试】页面。
2.3、测试
进入测试页面，输入参数值，点击【接口调用】按钮，系统将返回测试结果。完成后点击【保存并退出】即可。
3、修改API服务
选择需修改的API服务，在操作列中点击【修改】按钮，在弹出的页面中修改已有的API服务信息，修改完后点击【保存并退出】按钮，完成API服务信息修改。
4、删除API服务
选择需删除的API服务，在操作列中点击【删除】按钮，在出现的弹窗中点击【确定】按钮，完成API服务删除。
5、API服务详情
选择需查看详情的API服务，在操作列中点击【详情】按钮，在出现的页面中查看API服务详情。
6、上线/下线
选择需上线/下线的API服务，在状态列中点击【开关】按钮，即可完成上线/下线操作。
7、服务接口鉴权
7.1 背景说明
系统在 数据服务功能 中提供了统一的接口访问能力。调用方必须先通过 应用鉴权接口 获取 访问 Token，再携带该 Token 才能访问业务接口。
7.2 获取应用密钥
- 管理员在 基础管理 → 应用管理 中为指定人员创建或分配应用。
- 每个应用都会生成一组唯一凭据：
- client_id：应用标识
- client_secret：应用密钥
- 应用密钥（client_secret）在管理员界面是常驻可见的，由管理员复制并分配给对应的使用人员。
⚠️ 注意：
client_secret属于敏感信息，请使用人员妥善保管。若泄露，请联系管理员立即重置。
7.3 获取 Token
接口信息
- 接口路径：
POST http://127.0.0.1:8080/oauth2/client_token - 功能说明：通过
client_id与client_secret获取访问 Token
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| grant_type | string | 是 | 固定值 client_credentials，表示客户端模式 |
| client_id | string | 是 | 应用 ID |
| client_secret | string | 是 | 应用密钥 |
| scope | string | 否 | 可选参数，用于接口访问范围控制 |
返回参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| code | integer | 状态码（200 表示成功，500 表示失败） |
| msg | string | 返回消息说明 |
| data | null | 预留字段 |
| token_type | string | Token 类型，一般为 bearer |
| client_token | string | 访问 Token（调用接口时使用） |
| expires_in | integer | Token 有效期（单位：秒） |
| client_id | string | 返回的应用 ID |
| scope | string | Token 的作用域范围 |
7.4 鉴权测试
接口信息
- 接口路径：
POST http://127.0.0.1:8080/oauth2/test - 功能说明：用于验证获取到的
client_token是否有效
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| client_token | string | 是 | 通过鉴权接口获取的 Token |
返回参数
| 字段名 | 类型 | 说明 |
|---|---|---|
| msg | string | 成功时返回 test，失败时返回错误信息 |
| code | int | 状态码（200 表示成功，500 表示失败） |
返回示例
- 成功
"test"- 失败
{
"msg": "无效 client_token: 17Bg9WMOhQOthMR5Su67yLkGPDPSYAKM3i4ktNsyKNGMvOmO9hCPuDxnJL7x",
"code": 500
}7.5 使用 Token 调用业务接口
成功获取 client_token 后，在调用业务接口时必须在 请求参数中携带：
- 示例地址
http://127.0.0.1:8080/prod-api/services/v1.0.1/getDaDiscoveryTaskDO