README

PHP 的 Stack Pay Payments SDK 是一个开源库，您的 PHP 应用程序可以通过它轻松与 Stack Pay API 交互。

注意：此版本使用 Stack Pay API v1。客户端库的此版本与后续版本之间存在重大差异。升级时请务必注意。

要求

PHP 5.4.0（或更高版本）

依赖项

PHP Curl 类 7.2.0（或更高版本）

此库还要求 'ext-curl': '*'。

安装

Composer（推荐）

强烈建议您使用 Composer 安装此包及其依赖项。某些方法使用 GuzzleHttp。如果您不通过 Composer 安装，这些方法将难以使用。

要使用 Composer 安装，请运行以下命令

composer require stack-pay/payments-sdk-php

您还可以手动将此依赖项添加到您的 composer.json 文件中

{
    "require": {
        "stack-pay/payments-sdk-php": "~1.0.0"
    }
}

要使用绑定，请使用 Composer 的 autoload

require_once('vendor/autoload.php');

手动安装（不推荐）

如果您不想使用 Composer，可以下载最新版本。然后，为了使用绑定，请包含 payments-sdk.php 文件。

require_once('/path/to/stack-pay/payments-sdk-php/lib/payments-sdk.php');

您还需要下载依赖项并手动包含它们，这可能非常繁琐。强烈建议您使用 Composer。

实例化 SDK

$stackpay = new StackPay\Payments\StackPay($yourPublicKey, $yourPrivateKey);

这将创建一个使用 PRODUCTION 模式和默认货币 USD 的 StackPay 类实例。

要启用开发/测试模式，您应使用

$stackpay->enableTestMode();

更改货币

$stackpay->setCurrency('CAD');

文档

以请求为中心的实现

当通过 Composer 安装 SDK 时，建议使用这些文档中的示例。这些方法使用 GuzzleHttp，没有良好的自动加载器很难使用。

您可以直接使用 ->body() 方法与这些方法返回的响应交互，该方法是将响应有效负载的 JSON 解码的 Body 元素作为 stdClass PHP 对象。

$response = $request->send();

echo $response->body()->ID;

您可以使用 success() 方法检查响应是否成功。如果 success() 返回 false，则可以使用 error() 访问 code、messages 和 errors 属性。

$response = $request->send();

if (! $response->success()) {
    echo $response->error()->code."\n"; // the API response error code
    echo $response->error()->message."\n"; // the API response error message
    print_r($response->error()->errors); // populated when the request body does not pass validation
}

开发

安装依赖项

composer install

测试

如上所述安装依赖项（这将解决 PHPUnit），然后您可以运行测试套件

composer test

如果您打算使用这些测试，强烈建议您熟悉 PHPUnit 以及此包中包含的 phpunit.xml 配置文件。

支持

stackoverflow

贡献指南

请参阅 CONTRIBUTING.md（即将推出）

stack-pay / payments-sdk-php

维护者

详细信息