keboola/looker-api

7.0.0 2023-05-29 12:10 UTC

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

模型文档

授权文档

所有端点均不需要授权。

作者