README

此分支旨在支持PHP 8.1+。仅测试了Paystation API。Phpunit测试未维护。

已废弃的Xsolla SDK for PHP

官方的用于与Xsolla API交互的PHP SDK

此SDK可用于：

获取授权令牌
处理基本webhooks（用户验证、支付、退款等）

功能

使用不同的令牌获取方法来完全自定义支付UI。
所有API方法的客户端，使您的集成简单方便。您可以使用它来设置和更新虚拟货币、物品和订阅计划，管理用户余额，使用Report API检查财务信息等。
方便的webhook服务器
- 开始只需一个回调函数。
- 已实现所有安全检查：签名验证和IP白名单。
- 如果标准服务器类不合适，可以完全自定义通知处理逻辑。
SDK基于Guzzle v3构建，并利用了许多其功能，包括持久连接、并行请求、事件和插件（通过Symfony2 EventDispatcher）、服务描述、在线日志记录、缓存、灵活批处理以及带有截断指数退避的重试请求。

要求

PHP ^7.3 或 ^8.0
以下PHP扩展是必需的
- curl
- json

入门

请注册您的发布者账户并创建项目。为了使用PHP SDK库，您需要

商户ID
API密钥
项目ID
项目密钥

您可以通过公司资料和项目设置获取这些参数。

安装

通过Composer安装

安装Xsolla SDK for PHP的推荐方法是使用Composer。

$ cd /path/to/your/project
$ composer require frutality/xsolla-sdk-php

安装后，您需要要求Composer的自动加载器

require '/path/to/vendor/autoload.php';

通过Phar安装

您可以从此处下载打包的phar并将其包含到您的脚本中以开始使用。

require '/path/to/xsolla.phar';

通过 ZIP 安装

您可以从这里下载 ZIP 文件，将其解压到您的项目中您选择的任何位置，并包含自动加载器

require '/path/to/xsolla-autoloader.php';

快速示例

集成支付 UI

要将支付 UI 集成到您的游戏中，您应该获取一个访问令牌。访问令牌是一个字符串，用于标识游戏、用户和购买参数。

获取令牌有多种方式。最简单的方式是使用 createCommonPaymentUIToken 方法，您只需要传递 Xsolla 系统中项目的 ID 和您游戏中用户的 ID

<?php

use Xsolla\SDK\API\XsollaClient;

$client = XsollaClient::factory(array(
    'merchant_id' => MERCHANT_ID,
    'api_key' => API_KEY
));
$paymentUIToken = $client->createCommonPaymentUIToken(PROJECT_ID, USER_ID, $sandboxMode = true);

在您的页面中渲染支付 UI 脚本

<html>
<head lang="en">
    <meta charset="UTF-8">
</head>
<body>
    <button data-xpaystation-widget-open>Buy Credits</button>
    
    <?php \Xsolla\SDK\API\PaymentUI\PaymentUIScriptRenderer::send($paymentUIToken, $isSandbox = true); ?>
</body>
</html>

接收 webhooks

有一个内置的服务器类可以帮助您处理 webhooks。

<?php

use Xsolla\SDK\Webhook\WebhookServer;
use Xsolla\SDK\Webhook\Message\Message;
use Xsolla\SDK\Exception\Webhook\XsollaWebhookException;

$callback = function (Message $message) {
    switch ($message->getNotificationType()) {
        case Message::USER_VALIDATION:
            /** @var Xsolla\SDK\Webhook\Message\UserValidationMessage $message */
            // TODO if user not found, you should throw Xsolla\SDK\Exception\Webhook\InvalidUserException
            break;
        case Message::PAYMENT:
            /** @var Xsolla\SDK\Webhook\Message\PaymentMessage $message */
            // TODO if the payment delivery fails for some reason, you should throw Xsolla\SDK\Exception\Webhook\XsollaWebhookException
            break;
        case Message::REFUND:
            /** @var Xsolla\SDK\Webhook\Message\RefundMessage $message */
            // TODO if you cannot handle the refund, you should throw Xsolla\SDK\Exception\Webhook\XsollaWebhookException
            break;
        default:
            throw new XsollaWebhookException('Notification type not implemented');
    }
};

$webhookServer = WebhookServer::create($callback, PROJECT_KEY);
$webhookServer->start();

一旦您在服务器上完成通知的处理，请设置在项目设置页面接收所有 webhook 通知的 URL。

frutality / xsolla-sdk-php

维护者

详细信息