zamay86 / coinbase-commerce
Coinbase Commerce API 库
Requires
- php: >=7.4
- guzzlehttp/guzzle: ~5.0|~6.0|~7.0
- psr/http-message: ^1.0
Requires (Dev)
- phpunit/phpunit: ^9.0
- squizlabs/php_codesniffer: 3.*
This package is auto-updated.
Last update: 2024-09-10 16:49:08 UTC
README
原始包不再受支持。包的最新版本与流行的 Guzzle 包存在冲突。讨论
第三方用户创建了一个分支来修复问题,但后来他们删除了他们的 Github 账户。此包恢复了那个版本。
Coinbase Commerce
注意:此存储库未积极维护。
官方 PHP 库,用于Coinbase Commerce API。
目录
PHP 版本
支持 PHP 版本 5.4 及以上。
文档
更多详情请访问Coinbase API 文档。
要开始使用此库,请在Coinbase Commerce上注册账户。您可以在用户设置中找到您的API_KEY
。
初始化一个用于与 API 交互的 Client
。初始化客户端时,唯一必需的参数是 apiKey
,但您还可以传递 baseUrl
、apiVersion
和 timeout
。参数也可以在初始化后设置。
use CoinbaseCommerce\ApiClient; //Make sure you don't store your API Key in your source code! $apiClientObj = ApiClient::init(<API_KEY>); $apiClientObj->setTimeout(3);
禁用 SSL 检查
$apiClientObj->verifySsl(false);
API 资源类提供了以下静态方法:list, all, create, retrieve, updateById, deleteById
。此外,API 资源类还提供了以下实例方法:save, delete, insert, update
。
每个 API 方法都返回一个表示 API JSON 响应的 ApiResource
。当响应数据解析成对象时,将自动使用适当的 ApiResource
子类。
客户端支持处理常见的 API 错误和警告。在 API 交互期间发生的所有错误都将引发异常。
安装
使用 composer
安装
composer require zamay86/coinbase-commerce
使用
use CoinbaseCommerce\ApiClient; //Make sure you don't store your API Key in your source code! ApiClient::init('API_KEY');
结账
结账 API 文档有关如何使用结账的更多示例,请参阅examples/Resources/CheckoutExample.php
文件
加载结账资源类
use CoinbaseCommerce\Resources\Checkout;
检索
$checkoutObj = Checkout::retrieve(<checkout_id>);
创建
$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->cancel();
}
事件
事件 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的简单示例。
验证签名头
use CoinbaseCommerce\Webhook; try { Webhook::verifySignature($signature, $body, $sharedSecret); echo 'Successfully verified'; } catch (\Exception $exception) { echo $exception->getMessage(); echo 'Failed'; }
测试和贡献
欢迎任何形式的贡献!过程很简单:Fork此仓库,进行更改,运行测试套件,然后提交Pull Request。要运行测试,克隆仓库并执行以下命令
composer install
composer test
许可证
Apache-2.0