subscribepro / subscribepro-php

Subscribe Pro PHP SDK

1.1.6 2023-12-06 21:29 UTC

README

Latest Stable Version Total Downloads Latest Unstable Version License

这是我们访问Subscribe Pro REST API的PHP客户端库。我们的API文档可在https://docs.subscribepro.com/technical/rest-api/找到。

要了解更多关于Subscribe Pro的信息,您可以访问我们的网站https://www.subscribepro.com/

Composer

您可以通过Composer安装我们的PHP客户端。运行以下命令:

composer require subscribepro/subscribepro-php

要使用PHP客户端,请使用Composer的自动加载

require_once('vendor/autoload.php');

清理代码风格

安装php-cs-fixer v3.x后,在项目文件夹中运行以下命令:

php-cs-fixer fix

运行测试

通过Composer安装开发依赖项(这将安装phpunit >= 9.5),然后运行以下命令:

vendor/bin/phpunit

入门指南

简单使用示例(例如获取产品列表):

<?php

use SubscribePro\Sdk;

// Set credentials
$clientId     = 'XXXX';
$clientSecret = 'XXXX';

// Set log message format
$messageFormat = "SUBSCRIBE PRO REST API Call: {method} - {uri}\nRequest body: {req_body}\n{code} {phrase}\nResponse body: {res_body}\n{error}\n";

// Create SDK object
// Setup with Platform API base url and credentials from Magento config
$sdk = new Sdk([
    'client_id' => $clientId,
    'client_secret' => $clientSecret,
    'logging_enable' => true,
    'logging_file_name' => 'var/log/subscribe_pro_api.log',
    'logging_message_format' => $messageFormat,
    'api_request_timeout' => 60,
]);

$products = $sdk
    ->getProductService()
    ->loadProducts(['sku' => 'SOME-EXAMPLE-SKU']);