spinque/query-api

spinque desk 的 PHP 查询 API

维护者

详情

github.com/spinque/query-api-php

源代码

问题

安装: 2

依赖: 0

建议者: 0

安全性: 0

星标: 0

关注者: 4

分支: 0

开放问题: 0

v0.0.1 2023-10-03 14:36 UTC

Requires

  • php: >=8.1
  • ext-curl: *

MIT bfc5cba6279c62146ce2b5e1bf8c719201b6b819

  • spinque

This package is not auto-updated.

Last update: 2024-10-02 17:13:34 UTC

README

用于在 PHP 项目中使用 Spinque Query API 的库。

Spinque Query API 是一个 HTTP API，用于检索查询结果。还可以查看 Spinque Query API 的文档。

安装

此包可以通过 composer 使用。在您的 composer.json 文件中指定

  "require": {
      "spinque/query-api": "dev-main"
  }

然后，为了安装项目的依赖项

$ php composer.phar update

文档

有关 Spinque Query API 自身的文档，请参阅 此文档。

定义查询

<?php

require_once __DIR__ . '/vendor/autoload.php';

$api = new Api(
    array(
        'workspace' => 'course-chris',
        'config' => 'default',
        'api' => 'movies'
    )
);


$queries = [
    new Query('movie_search', array('query' => 'Keanu Reeves'))
];

try {
    echo $api->fetch($queries);
} catch (Exception $e) {
    echo $e;
}

身份验证

某些 Spinque API 需要通过 OAuth 2.0 进行身份验证。此库通过客户端凭据流程（用于服务器应用程序）提供了对身份验证的支持

<?php

require_once __DIR__ . '/vendor/autoload.php';

$api = new Api(
    array(
        'workspace' => 'course-chris',
        'config' => 'default',
        'api' => 'movies',
        'authentication' => array(
            'authServer' => 'https://login.spinque.com',
            'clientId' => '<CLIENT-ID>',
            'clientSecret' => '<CLIENT-SECRET>',
        )
    )
);

注意：客户端 ID 和客户端密钥可以通过在 Spinque Desk 的设置 > 团队成员部分创建新的系统到系统账户来生成。