README

Rebilly SDK for PHP 使得开发者能够轻松地在他们的 PHP 代码中访问 Rebilly REST APIs。

要求

• PHP 8.0+。
• CURL (验证对等方需要根证书颁发机构 -- 如果你还没有配置 php curl 使用一个，并且你的系统库没有链接到一个，你可能需要进行手动配置来使用适当的证书颁发机构)

安装

警告

此软件包不遵循语义版本控制，因此次要版本更新可能会导致向后兼容性中断。切换版本之前应测试软件包的更新。

使用 Composer 是安装 Rebilly SDK for PHP 的推荐方法。要开始，您需要运行 Composer 命令（假设您在项目的根目录中）。

• 安装 SDK 的最新稳定版本

composer require rebilly/client-php

有关如何安装 Composer、配置自动加载以及其他定义依赖项的最佳实践，请参阅 getcomposer.org。

支持版本

SDK 的先前版本可能已过时，无法提供与 REST APIs 通信的所有（或正确的）规范。只有最新版本始终受到支持。

快速示例

创建一个 Rebilly 客户端

use Rebilly\Sdk\Client;
use Rebilly\Sdk\Service;

// Instantiate Rebilly client.
$client = new Client([
    'baseUrl' => Client::SANDBOX_HOST,
    'organizationId' => '{organizationId}',
    'apiKey' => '{secretKey}',
]);
$service = new Service(client: $client);

创建一个客户

use Rebilly\Sdk\Exception\DataValidationException;
use Rebilly\Sdk\Model\ContactObject;
use Rebilly\Sdk\Model\Customer;

$customer = Customer::from([])
    ->setWebsiteId('{websiteId}')
    ->setPrimaryAddress(
        ContactObject::from([])
            ->setFirstName('John')
            ->setLastName('Doe'),
    );

try {
  $customer = $service->customers()->create($form);
} catch (DataValidationException $e) {
  var_dump($e->getValidationErrors());
}

更多请参阅 示例目录。

文档

阅读 Rebilly REST APIs 文档 了解更多详情。

从 SDK v2.x 迁移到 v3.x

这个新的大版本带来了几个新的辅助类来与 Rebilly REST APIs 进行通信，以及一些在切换 SDK 版本之前应该测试的不兼容性。

• 现在，可以显式实例化 Service 类来执行 API 调用，而不仅仅是使用 Client，因为它封装了 API 调用。

• 为了简化从先前版本的迁移，可以使用 Client 对象直接对任何 API 进行调用。例如，而不是实例化服务类，可以使用

  $client->customers()->create($form);

• 命名空间已从 Rebilly\Entities 更改为 Rebilly\Sdk\Model。现在，src 是 Rebilly\Sdk。

• 类现在由一个自动化的过程生成，该过程在每次发布新的 API 定义 时被触发。这意味着 SDK 更新的频率更高，使其与 REST APIs 保持同步。