Looker API 使用入门

Looker API 是一种安全的“RESTful”应用编程接口,可用于管理 Looker 实例并通过 Looker 数据平台提取数据。借助 Looker API,您可以编写应用或自动化脚本,用于预配新的 Looker 用户帐号、运行查询、定期生成报告等。您在 Looker API 中可以执行的任何操作都可以通过 Looker API 完成。

Looker API 路径和端口

通过 Looker 实例的 API 网址访问该实例的 API。

您的 Looker 管理员可以按以下格式指定 API 路径:在管理 > API 页面的 API 主机网址字段中输入路径:

https://<instance_name>.cloud.looker.com

您的 Looker 管理员还可以使用 API 主机网址字段来分配与 Looker 服务器机器名称不同的 API 路径。例如,当 Looker 安装在负载均衡器后面时,这种情况很常见。在这种情况下,请与您的 Looker 管理员联系,了解您的 API 路径。

如果您的 Looker 管理员尚未指定 API Host 网址(API 主机网址)字段,那么 Looker 会使用默认的 API 路径。对于在 Google Cloud、Microsoft Azure 上托管的 Looker 实例,以及 2020 年 7 月 7 日当天或之后创建的 Amazon Web Service (AWS) 上托管的实例,默认 Looker API 路径会使用端口 443。对于在 2020 年 7 月 7 日之前创建的 AWS 上托管的 Looker 实例,默认 Looker API 路径会使用端口 19999。默认 API 网址的格式如下:

https://<instance_name>.cloud.looker.com:<port>

上述 API 网址会连接到默认的 API 版本 4.0。您还可以连接到格式已弃用的 API(版本 3.1),格式为 https://<instance_name>.cloud.looker.com:<port>/api/3.1/user

客户端 SDK

您可以将 Looker API 与可发出 HTTPS 请求和处理 JSON 响应的任何编程语言或应用环境搭配使用。您可以使用 curl(或等效方法)、使用 Looker Ruby SDK 或根据您选择的语言生成客户端 SDK 库,手动构建 Looker API HTTPS 请求。我们建议您使用 SDK,因为它会为您处理身份验证和 HTTPS 请求的详细信息,这样您就可以通过简单的函数调用来调用 Looker API。

您可以在 Looker API SDK 文档页面中找到 SDK 的详细信息。

Authentication

Looker 通过在请求的 HTTP 授权标头中使用 OAuth 2.0 不记名访问令牌来对 API 请求进行身份验证。所有 Looker API 端点都需要安全的 HTTPS 连接,以便在传输过程中保证访问令牌的安全。

实现此步骤的步骤取决于您是否使用了 SDK。如需查看详细说明,请访问我们的 Looker API 身份验证文档页面。

交互式 API 文档

如需获取 API 参考文档,可从 Looker Marketplace 获取 API Explorer 扩展程序。如需了解详情,请参阅使用 API Explorer 文档页面。如果您是 Looker 管理员,也可以通过点击 Looker 的 API“管理”页面上的使用 API Explorer 链接来访问 API Explorer。

如果您无法访问安装了 API Explorer 的 Looker 实例,可以通过 Looker 的开发者门户查看公开版本。

版本控制

在构建应用时,API 稳定性是一项重要的考虑因素。为帮助您了解哪些端点将来可能会发生变化,以及哪些端点应保持稳定,我们将某些端点标记为 Beta 版。如需了解详情,请参阅 Looker API 版本控制文档页面。