keboola / looker-api
Requires
- php: >=5.5 <8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.2
Requires (Dev)
- friendsofphp/php-cs-fixer: ~2.12
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ~2.6
This package is auto-updated.
Last update: 2024-08-29 14:43:43 UTC
README
API 4.0 是 Looker API 的当前版本。API 3.1 已弃用。
授权
API 授权的经典方法使用 Looker API 凭证进行授权和访问控制。Looker 管理员可以在 Looker 的 管理员/用户 页面上创建 API 凭证。API 4.0 增加了额外的 API 请求认证方式,包括 OAuth 和 CORS 请求。有关详细信息,请参阅 Looker API 授权。
API 探索器
API 探索器是一个 Looker 提供的工具,具有许多新功能和独特功能,用于学习和使用 Looker API 和 SDK。有关详细信息,请参阅 API 探索器文档。
Looker 语言 SDK
Looker API 是一个 RESTful 系统,应该可以被任何能够发起 HTTPS 请求的编程语言使用。还提供了各种编程语言的 SDK,以简化 API 的使用。Looker 有一个开源的 sdk-codegen 项目,提供多种语言 SDK。由 sdk-codegen
生成的语言 SDK 具有认证管理器,可以在需要时自动认证 API 请求。有关可用的 Looker SDK 的详细信息,请参阅 Looker API 客户端 SDK。
API 版本控制
Looker 的未来版本将逐步发布最新的 API 版本,以安全地暴露 Looker 平台的核心功能,供 API 客户端应用程序使用。标记为“测试版”的 API 端点可能会在没有警告的情况下接收破坏性更改(但我们将尽量避免这样做)。稳定(非测试版)API 端点不应在未来版本中接收破坏性更改。有关详细信息,请参阅 Looker API 版本控制。
本版本包含的内容
引入了 API 4.0 版本,以调整 API 功能、参数和响应类型,以修复错误和不一致性。这些更改超出了我们可以在之前的 API 3.1 中进行的非破坏性增量更改范围。API 4.0 中这些类型调整的一个好处是,显著提高了对 TypeScript、Kotlin、Swift、Go、C# 等强类型语言的支持。有关 API 4.0 的更多信息,请参阅 API 4.0 GA 通告。API 探索器可用于 交互式比较 API 3.1 和 4.0 之间的差异。
API 和 SDK 支持策略
Looker API 版本和语言 SDK 具有不同的支持级别。请阅读 API 和 SDK 支持策略 以获取更多信息。
此 PHP 包由 Swagger Codegen 项目自动生成
- API 版本:4.0.23.6
- 构建包:io.swagger.codegen.languages.PhpClientCodegen。有关更多信息,请访问 https://help.looker.com
要求
PHP 5.5 及以上
安装 & 使用
Composer
要使用 Composer 安装绑定,请将以下内容添加到 composer.json
{
"repositories": [
{
"type": "git",
"url": "https://github.com/keboola/looker-api.git"
}
],
"require": {
"keboola/looker-api": "*@dev"
}
}
然后运行 composer install
手动安装
下载文件并包含 autoload.php
require_once('/path/to/SwaggerClient-php/vendor/autoload.php');
测试
要运行单元测试
composer install
./vendor/bin/phpunit
开始使用
请遵循安装程序,然后运行以下命令
<?php require_once(__DIR__ . '/vendor/autoload.php'); $apiInstance = new Swagger\Client\Api\AlertApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client() ); $limit = 789; // int | (Optional) Number of results to return (used with `offset`). $offset = 789; // int | (Optional) Number of results to skip before returning any (used with `limit`). try { $result = $apiInstance->alertNotifications($limit, $offset); print_r($result); } catch (Exception $e) { echo 'Exception when calling AlertApi->alertNotifications: ', $e->getMessage(), PHP_EOL; } ?>
API端点文档
所有URI均相对于https://example.looker.com:443/api/4.0
模型文档
- 访问令牌
- 警报
- 警报应用仪表板过滤器
- 警报条件状态
- 警报目的地
- 警报字段
- 警报字段过滤器
- 警报通知
- 警报补丁
- API会话
- API版本
- API版本元素
- 工件
- 工件命名空间
- 工件使用
- 备份配置
- 看板
- 看板项目
- 看板部分
- 颜色集合
- 颜色停止
- 列搜索
- 连接功能
- 内容收藏
- 内容元数据
- 内容元数据组用户
- 内容搜索
- 内容验证
- 内容验证警报
- 内容验证仪表板
- 内容验证仪表板元素
- 内容验证仪表板过滤器
- 内容验证错误
- 内容验证文件夹
- 内容验证查看
- 内容验证查看ML仪表板
- 内容验证查看ML仪表板元素
- 内容验证计划
- 内容验证器错误
- 内容视图
- 连续调色板
- 成本估算
- 创建成本估算
- 创建凭据API3
- 创建仪表板过滤器
- 创建仪表板渲染任务
- 创建嵌入用户请求
- 创建文件夹
- 创建OAuth应用程序用户状态请求
- 创建OAuth应用程序用户状态响应
- 创建查询任务
- 凭据API3
- 凭据电子邮件
- 凭据电子邮件搜索
- 凭据嵌入
- 凭据谷歌
- 凭据LDAP
- 凭据Looker OpenID
- 凭据OIDC
- 凭据SAML
- 凭据Totp
- 自定义欢迎邮件
- 数据库连接
- 数据库连接基础
- 数据库连接覆盖
- 数据库连接测试结果
- 仪表板
- 仪表板聚合表Lookml
- 仪表板外观
- 仪表板基础
- 仪表板元素
- 仪表板过滤器
- 仪表板布局
- 仪表板布局组件
- 仪表板Lookml
- 数据操作表单
- 数据操作表单字段
- 数据操作表单选择选项
- 数据操作请求
- 数据操作响应
- 数据操作用户状态
- 数据组
- 代理OAuth测试
- 依赖关系图
- 方言
- 方言信息
- 方言信息选项
- 摘要电子邮件发送
- 摘要电子邮件
- 离散调色板
- 出口IP地址
- 嵌入无Cookie会话获取
- 嵌入无Cookie会话获取响应
- 嵌入无Cookie会话生成令牌
- 嵌入无Cookie会话生成令牌响应
- 嵌入参数
- 嵌入密钥
- 嵌入SSO参数
- 嵌入URL响应
- 错误
- 外部OAuth应用程序
- 文件夹
- 文件夹基础
- Git分支
- Git连接测试
- Git连接测试结果
- Git状态
- 组
- 组层次结构
- 组包含中的组ID
- 组用户包含中的组ID
- 组搜索
- 首页项
- 首页部分
- 导入的项目
- 集成
- 集成中心
- 集成参数
- 集成必填字段
- 集成测试结果
- 内部帮助资源
- 内部帮助资源内容
- LDAP配置
- LDAP配置测试问题
- LDAP配置测试结果
- LDAP组读取
- LDAP组写入
- LDAP用户
- LDAP用户属性读取
- LDAP用户属性写入
- 遗留功能
- 区域设置
- 本地化设置
- 查看
- 查看基本
- 查看模型
- 查看包含仪表板
- 查看包含查询
- 查看ML模型
- 查看ML模型探索
- 查看ML模型探索访问过滤器
- 查看ML模型探索别名
- 查看ML模型探索始终过滤器
- 查看ML模型探索条件过滤器
- 查看ML模型探索错误
- 查看ML模型探索字段
- 查看ML模型探索字段枚举
- 查看ML模型探索字段映射层
- 查看ML模型探索字段度量过滤器
- 查看ML模型探索字段SQL条件
- 查看ML模型探索字段时间间隔
- 查看ML模型探索字段集
- 查看ML模型探索连接
- 查看ML模型探索集
- 查看ML模型探索支持度量类型
- 查看ML模型导航探索
- 查看ML测试
- 查看ML测试结果
- 清单
- MaterializePDT
- 合并字段
- 合并查询
- 合并查询源查询
- 移动功能标志
- 移动有效载荷
- 移动设置
- MobileToken
- 模型
- 模型字段建议
- 模型命名值格式
- 模型集
- 未验证的模型
- OIDC配置
- OIDC组读取
- OIDC组写入
- OIDC用户属性读取
- OIDC用户属性写入
- Oauth客户端应用
- 密码配置
- 权限
- 权限集
- 私有标签配置
- 项目
- 项目错误
- 项目文件
- 项目验证
- 项目验证缓存
- 项目工作空间
- 查询
- 查询任务
- 渲染任务
- 存储库凭证
- 结果生成器可过滤项
- 结果生成器可过滤项监听
- 具有ID、可视配置和动态字段的结果生成器
- 角色
- 角色搜索
- 正在运行的查询
- SAML配置
- SAML组读取
- SAML组写入
- SAML元数据解析结果
- SAML用户属性读取
- SAML用户属性写入
- 计划好的计划
- 计划好的计划目的地
- 架构
- 架构列
- 架构列集
- 架构表
- 架构表集
- 会话
- 会话配置
- 设置
- SMTP节点状态
- SMTP设置
- SMTP状态
- 代码片段
- SQL查询
- 创建SQL查询
- SSH公钥
- SSH服务器
- SSH隧道
- 支持访问添加条目
- 支持访问允许列表条目
- 支持访问启用
- 支持访问状态
- 主题
- 主题设置
- 时区
- 更新工件
- 更新文件夹
- 用户
- 用户属性
- 用户属性分组值
- 带值的用户属性
- 仅用户电子邮件
- 用户登录锁定
- 用户公开
- 验证错误
- 验证错误详情
- 欢迎电子邮件测试
- 白标签配置
- 工作空间
- 写入计划好的计划
授权文档
所有端点均不需要授权。