alexkart/looker-php-sdk

Looker API 的 PHP SDK

0.2.0 2023-06-02 09:37 UTC

This package is auto-updated.

Last update: 2024-08-31 00:41:27 UTC


README

API 4.0 是 Looker API 的当前版本。API 3.1 已弃用。### 授权经典方法使用 Looker API3 凭据进行授权和访问控制。Looker 管理员可以在 Looker 的 Admin/Users 页面上创建 API3 凭据。API 4.0 添加了额外的 API 请求认证方式,包括 OAuth 和 CORS 请求。有关详细信息,请参阅 Looker API 授权。### API 探索器API 探索器是一个 Looker 提供的实用工具,具有许多新的独特功能,用于学习和使用 Looker API 和 SDK。有关详细信息,请参阅 API 探索器文档。### Looker 语言 SDKLooker API 是一个 RESTful 系统,任何能够发送 HTTPS 请求的编程语言都可以使用。还提供了各种编程语言的 SDK 以简化 API 的使用。Looker 有一个开源的 sdk-codegen 项目,它提供了一些语言 SDK。由 sdk-codegen 生成的语言 SDK 具有认证管理器,可以在需要时自动认证 API 请求。有关可用的 Looker SDK 的详细信息,请参阅 Looker API 客户端 SDK。### API 版本化Looker 的未来版本通过分阶段发布最新的 API 版本,以安全地逐步向 API 客户端应用程序公开 Looker 平台的核心功能。标记为“beta”的 API 端点可能会收到未经警告的重大更改(但我们将尽量避免这样做)。稳定(非 beta)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.0
  • 构建包:io.swagger.codegen.languages.PhpClientCodegen 更多信息请访问 https://help.looker.com

此外,还有一个高级Looker PHP SDK。它在生成的SDK基础上增加了额外功能,使用更加方便,例如简化登录流程、自动访问令牌更新等。

安装与使用

Composer

composer require alexkart/looker-php-sdk

手动安装

下载文件并包含autoload.php

require_once('/path/to/looker-php-sdk/vendor/autoload.php');

入门指南

examples文件夹中查看使用示例。在login.php中设置您的API凭证。

需求

PHP 5.5及以后版本

测试

要运行单元测试

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://localhost:20000/api/3.1

模型文档

授权文档

所有端点均不需要授权。

作者