README

Coinbase Commerce

官方 PHP 库，用于 Coinbase Commerce API。

$checkoutData = [
    'name' => 'The Sovereign Individual',
    'description' => 'Mastering the Transition to the Information Age',
    'pricing_type' => 'fixed_price',
    'local_price' => [
        'amount' => '100.00',
        'currency' => 'USD'
    ],
    'requested_info' => ['name', 'email']
];
$newCheckoutObj = Checkout::create($checkoutData);

// or

$newCheckoutObj = new Checkout();

$newCheckoutObj->name = 'The Sovereign Individual';
$newCheckoutObj->description = 'Mastering the Transition to the Information Age';
$newCheckoutObj->pricing_type = 'fixed_price';
$newCheckoutObj->local_price = [
    'amount' => '100.00',
    'currency' => 'USD'
];
checkoutObj->requested_info = ['name', 'email'];

checkoutObj->save();

更新

$checkoutObj = new Checkout();

$checkoutObj->id = <checkout_id>;
$checkoutObj->name = 'new name';

$checkoutObj->save();
// or
$newParams = [
    'name' => 'New name'
];

Checkout::updateById(<checkout_id>, $newParams});

删除

$checkoutObj = new Checkout();

$checkoutObj->id = <checkout_id>;
$checkoutObj->delete();

// or

Checkout::deleteById(<checkout_id>);

列表

列表方法返回 ApiResourceList 对象。

$params = [
    'limit' => 2,
    'order' => 'desc'
];

$list = Checkout::getList($params);

foreach($list as $checkout) {
    var_dump($checkout);
}

// Get number of items in list
$count = $list->count();

// or
$count = count($list);

// Get number of all checkouts
$countAll = $list->countAll();

// Get pagination
$pagination = $list->getPagination();

// To load next page with previous setted params(in this case limit, order)
if ($list->hasNext()) {
    $list->loadNext();
    
    foreach($list as $checkout) {
        var_dump($checkout);
    }
}

获取所有结账

$params = [
    'order' => 'desc'  
];

$allCheckouts = Checkout::getAll($params);

费用

费用 API 文档更多关于如何使用费用的示例可以在 examples/Resources/ChargeExample.php 文件中找到

加载费用资源类

use CoinbaseCommerce\Resources\Charge;

检索

$chargeObj = Charge::retrieve(<charge_id>);

创建

$chargeData = [
    'name' => 'The Sovereign Individual',
    'description' => 'Mastering the Transition to the Information Age',
    'local_price' => [
        'amount' => '100.00',
        'currency' => 'USD'
    ],
    'pricing_type' => 'fixed_price'
];
Charge::create($chargeData);

// or
$chargeObj = new Charge();

$chargeObj->name = 'The Sovereign Individual';
$chargeObj->description = 'Mastering the Transition to the Information Age';
$chargeObj->local_price = [
    'amount' => '100.00',
    'currency' => 'USD'
];
$chargeObj->pricing_type = 'fixed_price';
$chargeObj->save();

列表

$list = Charge::getList();

foreach($list as $charge) {
    var_dump($list);
}

$pagination = $list->getPagination();

获取所有费用

$allCharges = Charge::getAll();

解决费用

解决已被标记为未解决的费用。

$chargeObj = Charge::retrieve(<charge_id>);

if ($chargeObj) {
    $chargeObj->resolve();
}

取消费用

取消已创建的费用。注意：只有新费用才能成功取消。一旦检测到付款，费用就无法取消。

$chargeObj = Charge::retrieve(<charge_id>);

if ($chargeObj) {
    $chargeObj->confirm();
}

事件

事件 API 文档更多关于如何使用事件的示例可以在 examples/Resources/EventExample.php 文件中找到

加载事件资源类

use CoinbaseCommerce\Resources\Event;

检索

$eventObj = Event::retrieve(<event_id>);

列表

$listEvent = Event::getList();

foreach($listEvent as $event) {
    var_dump($event);
}

$pagination = $listEvent->getPagination();

获取所有事件

$allEvents = Event::getAll();

警告

注意警告。如果配置了标准 PSR-3 日志记录器，库将记录所有警告。

use CoinbaseCommerce\ApiClient;

//Make sure you don't store your API Key in your source code!
$apiClientObj = ApiClient::init(<API_KEY>);
$apiClientObj->setLogger($logger);

Webhooks

Coinbase Commerce会对发送到您端点的webhook事件进行签名，这样您就可以验证并确认这些事件不是由其他人发送的。您可以在examples/Webhook文件夹中找到一个使用Express实现这一功能的简单示例，链接为：示例/Webhook

验证签名头

use CoinbaseCommerce\Webhook;

try {
    Webhook::verifySignature($signature, $body, $sharedSecret);
    echo 'Successfully verified';
} catch (\Exception $exception) {
    echo $exception->getMessage();
    echo 'Failed';
}

测试和贡献

欢迎所有贡献！流程很简单：Fork此仓库，进行您的更改，运行测试套件，并提交pull请求。要运行测试，请克隆仓库并运行以下命令

composer install
composer test

许可协议

Apache-2.0

ramiroauditore / coinbase-commerce

维护者

详细信息