常见业务场景示例

场景1：业务系统对接订单数据

创建订单分页查询API，配置订单状态、时间范围筛选参数，绑定业务系统应用并授权，业务系统通过API获取订单数据，用于页面展示。

场景2：BI工具数据分析

创建订单金额统计API，按日期、品类分组返回统计数据，绑定BI应用，BI工具通过API拉取数据，生成可视化报表，无需直接连接数据库。

场景3：第三方应用数据共享

创建非敏感数据查询API（如商品基础信息），绑定第三方应用，设置限流策略（如每秒最多10次调用），避免过度请求影响系统稳定性。

新建API流程归纳

下图是在数据服务平台上创建API并进行API申请的基本流程图：

对于不同的角色可选择不同的模块创建API或者直接申请API使用。

API开发者：
对于API开发者，需要选择具体的数据源、表、配置请求参数和返回参数，正确配置API的取数逻辑，对API进行测试，API测试成功后即可发布API；

API调用者：
对于API调用者，可以在API集市查看详情，支持申请API，支持新创建应用，生成appkey和Secert，同时下载操作文档，正确调用API。

新建API基本流程：

1. 登记数据源；
2. 创建API集合；
3. 新建API，选择创建的API类型，包括新建API、注册API、服务编排和标签画像API(只有在包含标签画像产品且版本在3.7.0+才支持该类型)；
4. 配置API基本信息：包括协议、请求方式、返回类型和设置超时时间等；
5. 配置API参数：根据选择不同的API类型，配置界面不一样，比如选择新建API，则需要配置请求参数和返回参数，包括参数名称、类型和描述等；
6. 保存和测试：在线发送请求，显示请求详情和返回内容；
7. 发布API：测试成功的API才可以进行发布；
8. 绑定应用：处于发布状态的API才可以授权应用。

API类型

数据服务平台支持基于数据库表生成API的新建API类型、将第三方API注册至平台的注册API类型、使用条件节点或python、UDF等对API进行业务逻辑处理的服务编排类型、使用将已定义完成的指标数据生成指标API进行（需要在包含"指标平台"产品时才支持该功能）、以及将标签画像数据生成API的类型(只有在包含标签画像产品且版本在3.7.0+才支持该类型)。

新建API

数据服务平台支持将数据库表通过新建API的方式生成API，支持MySQL、HBase、Redis、MongoDB等多种数据源类型的API构建。

注册API

平台支持将已有的API通过注册功能，统一由数据服务平台进行管理。

API注册整体流程如下：

1. 登记API数据源类型；
2. 创建API集合；
3. 在API列表选择注册API功能；
4. 配置API基本信息：包括API名称、协议、返回类型、设置超时时间等；
5. 配置API参数：选择已注册的API数据源，添加请求参数和响应示例；
6. 保存和测试：在线发送请求，测试注册API的连通性和返回内容；
7. 发布API：测试成功的API才可以进行发布；
8. 绑定应用：处于发布状态的API才可以授权应用。

新建 API 与注册 API 在创建完成后，均需先绑定应用并通过应用鉴权，方可被调用；待 API 发布至 API 集市后，支持其他用户申请使用权限。

新建服务编排

服务编排API是可以基于画布，通过托拉拽的方式定义查询工作流，支持API节点、脚本节点(支持python 2.7，用于数据处理)、条件节点(支持python2.7，用于工作流分支控制)和UDF节点，完成复杂的API业务逻辑处理，比如完成异构数据源的关联查询、条件取数等较为复杂的流程。

新建标签画像API

标签画像API的类型只有在包含"标签画像"产品且版本为3.7.0+才支持。支持将标签画像侧的标签和群组数据以API的方式开放出去，更好的对接上游应用系统，完成标签从开发到应用的闭环流程。

指标API

指标API类型需要系统包含“指标平台”系统功能才能支持。可以让企业内部的各类系统 / 工具能快速、统一地获取标准化的业务指标数据（比如销售额、订单量、用户活跃度等），避免指标口径混乱、取数效率低的问题。

更多有关新建API的详细信息，可查看新建API和注册API、服务编排、指标API和标签画像API章节

使用常见问题

问题1：API测试报错“数据源连接失败”？

需要检查数据源登记信息是否正确、网络是否连通、数据源账号密码是否有效，同时确认源系统账号鉴权配置是否适配。

问题2：API调用无数据返回？

检查筛选参数是否正确、目标表是否有对应数据、API返回字段是否勾选，可通过测试页面调整参数重新请求。

问题3：无法绑定API到应用？

确认API已发布，应用状态为“正常”，且账号拥有API与应用的管理权限。

问题4：API调用耗时过长？

优化筛选条件（如增加索引）、减少返回字段数量、调整分页大小，避免一次性查询大量数据。