README

我们提供了PHP的简单RedlinkAPI v2.1客户端。

查看

安装

此版本支持PHP >= 7.2。要开始使用，只需使用Composer要求项目。您还需要安装提供“psr/http-client-implementation”和“psr/http-factory-implementation”的包。

标准安装

要安装客户端，您需要在项目中使用Composer。以下是安装Composer的方法

curl -sS https://getcomposer.org/installer | php

获取Composer后，您需要安装两个包 - 此存储库和PSR HTTP客户端实现（例如Guzzle / Buzz）

$ composer require plotkabytes/redlink-api-php-client guzzlehttp/guzzle

此项目使用以下PSR

通用库使用

示例脚本

<?php

// Use composer autoloader
require __DIR__ . '/../vendor/autoload.php';

use Psr\Http\Message\ResponseInterface;
use Plotkabytes\RedlinkApi\Utils\ResponseTransformer;

// Create client
$client = new \Redlink\DefaultClient();

// Setup authentication
$client->setAuthentication("ENTER_API_KEY_HERE", "ENTER_APPLICATION_KEY_HERE"); // authentication v2

// Do something
$response = $client->groups()->list();

// Optional, transform response to objects
$responseTransformer = new ResponseTransformer();

/**
 * @var $parsedResponse RedlinkResponse 
 */
$parsedResponse = $responseTransformer->createFromJson($response->getBody());

print_r($parsedResponse->getData());
print_r($parsedResponse->getErrors());;
print_r($parsedResponse->getMeta());

如果您不确定如何使用此库中的给定方法，请查看我们的示例。

API方法的详细信息可以在官方文档页面上找到。

使用插件

此库支持插件。

插件系统允许在发送实际请求之前和/或之后包装客户端并添加一些处理逻辑。

测试

$ docker-compose up -d
$ docker exec -it redlink-api-php-lib /bin/bash
$ composer install
$ php vendor/bin/phpstan analyze -c /var/www/html/phpstan.neon.dist
$ php vendor/bin/phpunit
$ php vendor/bin/psalm.phar
$ composer auto-format

框架集成

Symfony支持

Symfony支持由此包提供。

它支持Symfony >= 5.3和PHP >= 7.2。

Laravel支持

待办事项

版本控制

我们使用语义版本控制 2.0.0。

给定版本号 MAJOR.MINOR.PATCH，当您进行不兼容的 API 变更时，增加

MAJOR 版本；当您以向后兼容的方式添加功能时，增加
MINOR 版本；当您进行向后兼容的错误修复时，增加
PATCH 版本。

预发布和构建元数据标签可作为 MAJOR.MINOR.PATCH 格式的扩展使用。

贡献

我们乐意接收问题报告并审查和接受 pull 请求。请随意以任何方式做出贡献。

作者

Mateusz Żyła mateusz.zylaa@gmail.com

许可证

Redlink PHP API 客户端采用 MIT 许可证 (MIT) 许可。

plotkabytes / vercom-api-php-client

维护者

详情