README

WeArePlanet PHP 库

WeArePlanet PHP 库封装了 WeArePlanet API。此库简化了您与各种服务（如交易、账户和订阅）的交互。

文档

WeArePlanet 网络服务 API

要求

PHP 5.6.0 及以上版本

安装

您可以使用 Composer 或 手动安装

Composer

首选方法是通过 composer。如果您尚未安装 composer，请遵循安装说明。

安装 composer 后，在您的项目根目录中执行以下命令以安装此库

composer require weareplanet/sdk

手动安装

或者，您可以下载整个包。在发布页面中列出了所有稳定版本。

解压缩您下载的 zip 文件，并在您的项目中包含自动加载器

require_once '/path/to/php-sdk/autoload.php';

用法

该库需要配置您的账户空间 ID、用户 ID 和密钥，这些信息可在您的 WeArePlanet 账户仪表板中找到。将 space_id、user_id 和 api_secret 设置为其值。

配置服务

require_once(__DIR__ . '/autoload.php');

// Configuration
$spaceId = 405;
$userId = 512;
$secret = 'FKrO76r5VwJtBrqZawBspljbBNOxp5veKQQkOnZxucQ=';

// Setup API client
$client = new \WeArePlanet\Sdk\ApiClient($userId, $secret);

// Get API service instance
$client->getTransactionService();
$client->getTransactionPaymentPageService();

要开始发送交易，请查看以下示例

require_once(__DIR__ . '/autoload.php');

// Configuration
$spaceId = 405;
$userId = 512;
$secret = 'FKrO76r5VwJtBrqZawBspljbBNOxp5veKQQkOnZxucQ=';

// Setup API client
$client = new \WeArePlanet\Sdk\ApiClient($userId, $secret);

// Create transaction
$lineItem = new \WeArePlanet\Sdk\Model\LineItemCreate();
$lineItem->setName('Red T-Shirt');
$lineItem->setUniqueId('5412');
$lineItem->setSku('red-t-shirt-123');
$lineItem->setQuantity(1);
$lineItem->setAmountIncludingTax(29.95);
$lineItem->setType(\WeArePlanet\Sdk\Model\LineItemType::PRODUCT);


$transactionPayload = new \WeArePlanet\Sdk\Model\TransactionCreate();
$transactionPayload->setCurrency('EUR');
$transactionPayload->setLineItems(array($lineItem));
$transactionPayload->setAutoConfirmationEnabled(true);

$transaction = $client->getTransactionService()->create($spaceId, $transactionPayload);

// Create Payment Page URL:
$redirectionUrl = $client->getTransactionPaymentPageService()->paymentPageUrl($spaceId, $transaction->getId());

header('Location: ' . $redirectionUrl);

HTTP 客户端

您可以使用 php curl 或 php socket 扩展。建议您安装必要的扩展并在系统上启用它们。

您有两种方式指定您首选的 HTTP 客户端。

$userId = 512;
$secret = 'FKrO76r5VwJtBrqZawBspljbBNOxp5veKQQkOnZxucQ=';

// Setup API client
$client = new \WeArePlanet\Sdk\ApiClient($userId, $secret);

$httpClientType = \WeArePlanet\Sdk\Http\HttpClientFactory::TYPE_CURL; // or \WeArePlanet\Sdk\Http\HttpClientFactory::TYPE_SOCKET

$client->setHttpClientType($httpClientType);

//Setup a custom connection timeout if needed. (Default value is: 25 seconds)
$client->setConnectionTimeout(20);

您还可以通过 PLN_HTTP_CLIENT 环境变量指定 HTTP 客户端。可能的字符串值是 curl 或 socket。

<?php
putenv('PLN_HTTP_CLIENT=curl');
?>

将 Webhook 负载签名机制集成到 Webhook 回调处理程序中

现在发送给实体状态更改的 HTTP 请求包含一个额外的字段 state，该字段提供了有关监控实体状态更新的信息。此增强功能是我们 Webhook 加密机制实施的结果。

负载字段 state 提供了有关实体状态更新的直接信息，这使得调用 API 以检索实体状态的额外 API 调用变得多余。

⚠️ 警告：通用伪代码

提供的伪代码是故意通用的，用于说明增强您的 API 以利用 Webhook 负载签名的过程。它不是一个完整的实现。

请确保您将此代码修改和扩展以满足您应用的特定需求，包括适当的安全措施和错误处理。为了详细了解 Webhook 负载签名机制，我们强烈建议您参考我们的全面Webhook 负载签名文档。

public function handleWebhook() {
    $requestPayload = file_get_contents('php://input');
    $signature = $_SERVER['HTTP_X_SIGNATURE'] ?? '';

    if (empty($signature)) {
        // Make additional API call to retrieve the entity state
        // ...
    } else {
        if ($client->getWebhookEncryptionService()->isContentValid($signature, $requestPayload)) {
            // Parse requestPayload to extract 'state' value
            // $state = ...
            // Process entity's state change
            // $this->processEntityStateChange($state);
            // ...
        }
    }

    // Process the received webhook data
    // ...

}

许可

有关更多信息，请参阅许可文件。

weareplanet / sdk

维护者

详细信息