README

HbsResearch\Tilkee PHP 是用 PHP 编写的 HbsResearch\Tilkee 客户端。
此客户端支持 API v1

重要：此库目前不支持完整的 API。
欢迎您为 swagger 规范做出贡献

安装

推荐通过 Composer 安装 HbsResearch\Tilkee PHP

composer require hbs-research/tilkee-php

使用示例

列出项目

<?php

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

use Http\Message\Authentication\Bearer;

use HbsResearch\Tilkee\HbsResearch\Tilkee;
use HbsResearch\Tilkee\TilkeeClient;

// Place here your API key or Oauth Token
$token = 'YOUR_TOKEN';
// Here is your unique tilk ref provided by HbsResearch\Tilkee
$tilkRef = 'TilkTestClient';


$authentication = new Bearer($token);
$tilkeeClient = new TilkeeClient($authentication, $tilkRef);
$tilkee = new HbsResearch\Tilkee($tilkeeClient);

$projectList = $tilkee->getProjectManager()->listProject()->getContents();

foreach ($projectList as $project) {
    echo sprintf("%s: %s\n", $project->getId(), $project->getName());
}

重新生成 API 模板

# get jane OpenAPI
composer install --dev

rm -rf generated/*
./vendor/bin/jane-openapi generate -c .jane-openapi

使用 Docker

如果您不想破坏系统，可以使用提供的 Docker Dockerfile。

docker build --rm -t tilkee-php .

然后，使用快捷方式 tilkee

./bin/tilkee your_command_here

贡献

请参阅 CONTRIBUTING 以获取详细信息。

致谢

此库使用 Jane Open Api 从自定义的 OpenApi (Swagger) 规范文件 tilkee-swagger.yml 生成 API 模板。

此 README 是由 @willdurand 的 willdurand/Negotiation 启发的。

许可协议

MIT 许可协议 (MIT)。请参阅许可文件以获取更多信息。

efficimo / tilkee-php

维护者

详细信息