数据服务
TapData Enterprise 可部署在您的本地数据中心,适合对数据敏感性或网络隔离有严格要求的场景,可服务于构建实时数仓,实现实时数据交换,数据迁移等场景。TapData 支持 API 形式发布表数据,帮助企业构建统一的数据服务平台,各类应用可基于 API 为推送服务等应用提供支持,推荐的使用顺序如下:
步骤 | 说明 |
---|---|
创建 API 应用 | 基于 API 的用途进行分组管理。 |
创建 API 服务 | 选择需要关联的表,设置 API 的名称、版本、访问路径、权限范围等信息,设置完成后发布上线即可。 |
创建 API 客户端 | 基于业务需求设置权限范围和认证方式,保障 API 服务的安全性。 |
调用 API 服务 | 支持 RESTful 和 GraphQL 访问方式。 |
审计和监控 | 审计和监控 API 调用情况,满足合规和安全性等需求。 |
📄️ 应用管理
为更好地管理和区分 API 服务,我们可以基于业务对其进行分类,将不同的 API 划入不同的应用中,本文介绍具体的操作流程。
📄️ 创建数据服务
为了方便开发人员进行接口对接,同时也方便查看通过 TapData 发布的 API 信息,我们提供了数据服务功能。
📄️ 创建客户端
API客户端是用来管理和创建调用API,开发者设计开发的应用程序或者其他需要调用 API 接口的应用程序(统称客户端应用)在接入数据发布系统前需要先注册,注册完成后,得到一个专属客户端ID(clientid)和客户端密钥(clientsecret)
📄️ 创建服务器
API 服务器可以配置对外暴露的API服务器地址,也可以增加多个服务器。
📄️ 服务审计
服务审计主要用来查看 API 的访问记录,可查看每次请求的记录包括访问类型、访问人员、IP 地址、访问时间、访问结果、失败原因等等,也可按不同条件进行筛选。
📄️ 服务监控
通过服务监控可对平台上的API请求进行监控管理,可查看全局的统计和每个API的状态
📄️ API 认证介绍
TapData 的 API 认证服务基于 OAuth 2.0 机制,默认支持 client credentials、implicit 授权方式,您可以在创建客户端时选择授权方式。本文将介绍 API 认证流程,包含如何获取访问令牌,帮助您快速使用 API 服务。
📄️ 通过 RESTful 查询 API
RESTful API 是遵循 REST 架构规范的应用编程接口(API 或 Web API),TapData 支持集成了 RESTful API 服务,您可以通过 API 服务地址来执行请求,获取经治理后的数据信息。
📄️ 通过 GraphQL 查询 API
GraphQL 提供了一种查询语言,支持以声明方式从服务器请求数据,例如请求架构中的特定数据。TapData 集成了 GraphQL,您可以通过 API 服务地址来执行请求。
📄️ API 查询参数说明
调用已发布的 API 接口时,支持在 URL 查询字符串中添加查询条件,从而查询结果的快速过滤。本文介绍支持的过滤器和相关使用示例。