通过 RESTful 查询 API

TapData Enterprise 可部署在您的本地数据中心，适合对数据敏感性或网络隔离有严格要求的场景，可服务于构建实时数仓，实现实时数据交换，数据迁移等场景。

RESTful API 是遵循 REST 架构规范的应用编程接口（API 或 Web API），TapData 支持集成了 RESTful API 服务，您可以通过 API 服务地址来执行请求，获取经治理后的数据信息。

本文我们将介绍如何借助 Postman 工具来调用 API 请求。

操作步骤

1. 登录 TapData 平台。

2. 在左侧导航栏，选择数据服务 > 服务管理。

3. 获取服务访问地址和 Access Token 认证信息。

   1. 找到并单击目标服务名称。

   2. 在右侧面板中，下翻至服务访问区域，获取服务访问的地址，本案例中，我们以 GET 类型的服务为例演示操作流程。

      

   3. 单击调试标签页，下翻至示例代码，获取 Access Token 认证信息。

      

4. 打开 Postman 工具，然后在软件页面的顶部单击 Workspaces 并选择您的 Workspace。

5. 单击 New，然后在弹出的对话框中选择 HTTP Request。

   

6. 在 Request URL 文本框中，填写您在步骤 3 中获取到的 API 查询请求地址。

7. （可选）单击文本框下方的 Query Params，设置查询的请求参数，支持的请求参数介绍请参加步骤 3。

8. 单击文本框下方的 Authorization，选择 Type 为 Bearer Token 并填写您在步骤 3 中获取到的 Access Token 认证信息。

   

9. 单击 Query，返回示例如下。

   

   提示

   TapData 支持在 URL 查询字符串中添加查询条件，从而查询结果的快速过滤，具体操作，见 API 查询参数说明。

常见响应码

响应码	消息	说明
200	OK	正常请求
401	Unauthorized error: token expired	令牌已过期，请重新生成令牌
404	Not Found error: endpoint not found	API不存在。可能是API地址错误或API尚未成功发布，请检查请求的API地址，或等待一段时间直到API发布后再重新请求。
429	Rate limit exceeded. Maximum \${api limit} requests per second allowed	由于访问频率超过API允许的最大访问频率，请求受到限制。请等待片刻后重新访问，或调整API配置页面的访问频率限制。

常见问题

• Q：API 返回数据很慢怎么办？

  A：先确认 API 使用的数据源配置，再检查对应字段是否都有索引；若未建索引，请在数据源上为相关参数补充索引以提升查询性能。

• Q：API 返回的数据不符合预期怎么办？

  A：检查 API 使用的数据源模型及其对应的表，确认模型数据是否正常、字段合并逻辑是否符合预期。