README

支付助手的合作伙伴API的PHP SDK。

注意

paymentassist-php v2现在是默认版本。对于旧版集成，请参阅v1分支。

依赖项

• PHP >= 7.2
• PHP JSON扩展
• PHP cURL扩展

工作流程

安装

使用Composer安装

composer require paymentassist/paymentassist-php:dev-v2

发布配置文件

使用Composer发布配置文件

composer --working-dir=vendor/paymentassist/paymentassist-php/ run-script publish-config

使用方法

use PaymentAssist\ApiClient;

$config = [
    'debug'                  => true,
    'timeout'                => 120,
    'log'                    => [
        'debug'                       => true,
        'log_file_name'               => 'apiclient.log',
        'log_file_path'               => 'PATH-TO-YOUR-LOGS-FOLDER',
        'log_request_before_response' => true,
        'log_app_name'                => 'ApiClient',
        'log_format'                  => null, // if null, a default format from GuzzleHttp\MessageFormatter class will be used
    ],
    'verify_ssl_certificate' => true,
    'default'                => 'partner_api_v1',
    'connections'            => [
        'partner_api_v1' => [
            'base_uri'               => 'https://api.v1.payment-assist.co.uk',
            'manifest_path'          => 'default', // use manifest files stored within the package
            'api_key'                => 'YOUR-KEY',
            'secret'                 => 'YOUR-SECRET',
            'additional_query_param' => [],
        ],
    ],
];
        
$client   = ApiClient::instance($config)->setConnection(ApiClient::PARTNER_API_V1);
$response = $client->GetAccountConfigurationDetails();

if ($response->isOK()) {
    $plans = collection(
        $response
            ->getContent()
            ->getData()
            ->getPlans()
            ->toArray()
    )->map(function ($plan) {
        return $plan['name'];
    })->toList();
} else {
    echo($response->getStatus() . ' ' . $response->getReason());
    echo('There was an error fetching plans from the API: ' . $response->getContents()->getMessage());
}

在上面的示例中，$config变量包含一个需要作为参数传递给ApiClient::instance()静态方法的配置结构。

此结构可以存储在应用程序的配置部分。安装该软件包后，您可以发布一个示例配置文件。如果存在，Composer脚本将复制文件apiclient.php到应用程序根目录中的config文件夹，否则它将复制文件到应用程序的根目录。

配置文件包含结构和默认配置值，这些值可以被存储在文件.apiclient.env中的值覆盖，该文件将被复制到应用程序的根目录。

有关有效端点和所需参数的详细信息，请参阅API文档。

贡献

我们欢迎贡献。有多种方式可以帮助

• 如果在GitHub上发现错误，请创建一个问题。
• 为开放错误/功能问题编写补丁，最好包括测试用例。请从我们的存储库分叉，在新分支中做出更改，然后提交一个拉取请求，确保正确的目标分支。
• 为文档做出贡献

支持

对于集成支持，请通过电子邮件itsupport@payment-assist.co.uk联系。