README

轻松使用 Rebrandly 网址缩短器的 API。

需求

此软件包需要 PHP 7.4 或更高版本。

安装

此软件包可以用于任何 PHP 项目或框架。

您可以通过 composer 安装此软件包

composer require vdhicts/rebrandly-api-client

使用

此软件包试图提供 Rebrandly API 的完整实现。某些端点受 Rebrandly 提供的某些计划限制（如脚本和标签）。

快速使用

所有端点都可以从 Rebrandly 类中检索。此类需要 Client。

use Vdhicts\Rebrandly;

// Initialize the client and the Rebrandly instance
$client = new Rebrandly\Client('API_KEY');
$rebrandly = new Rebrandly\Rebrandly($client);

// Access the endpoints
$linksEndpoint = $rebrandly->links();

例如，检索所有链接

$links = $rebrandly->links()->list();

选项

Rebrandly API 的某些端点提供一些筛选。这些过滤器可以在 Options 类中设置。例如，按点击次数对链接进行排序

$links = $rebrandly->links()->list(new Options(['orderBy' => 'clicks', 'orderDir' => 'asc']));

模型

此客户端将始终返回相关的模型。创建新资源时，对象将提供给 create 方法。例如，创建链接

$link = new Rebrandly\Models\Link();
$link->setDestination('https://time-tracker.vdhicts.nl');
$link->setSlashtag('time-tracker');
$link->setDomain($domain);

$rebrandly->links()->create($link);

要为您自定义域名创建链接，您需要在 Link 模型中指定域名

$domain = new Rebrandly\Models\Domain();
$domain->setFullName('yourdomain.tld');

$link->setDomain($domain);

$rebrandly->links()->create($link);

异常

当出现问题时，客户端将抛出 RebrandlyException。如果您想捕获此软件包中的异常，请捕获该异常。API 的错误响应也会导致 RebrandlyException。

Laravel

对于 Laravel 用户，建议将 API 密钥添加到您的 .env 文件中

REBRANDLY_API_KEY="your-key"

然后为 Rebrandly 创建一个配置文件或将此内容添加到您的项目配置文件中。然后使用配置值初始化客户端

$client = new Rebrandly\Client(config('rebrandly.api_key'));

测试

单元测试位于 tests 文件夹中。通过 phpunit 运行

vendor\bin\phpunit

默认情况下，覆盖率报告将在 build/coverage 文件夹中生成。

贡献

欢迎任何贡献，但应满足 PSR-2 标准，并且请为每个功能创建一个拉取请求。作为交换，您将作为贡献者在此页面上获得认可。

安全

如果您在此或其他 Vdhicts 软件包中发现任何与安全相关的问题，请通过电子邮件 security@vdhicts.nl 反馈，而不是使用问题跟踪器。

许可

此软件包是开源软件，根据 MIT 许可 许可。

支持

此软件包不是 Rebrandly 的官方软件包，因此他们可能不会提供对该软件包的支持。如果您遇到此客户端的问题，请在 GitHub 上创建问题。

关于 vdhicts

Vdhicts 是我的个人公司的名称。Vdhicts 为企业和教育机构开发并实施 IT 解决方案。