DV-NET PHP 客户端
这是用于集成 DV-NET Merchant API 的官方 PHP 客户端。它提供对所有 API 端点的便捷访问、处理请求签名,并将响应映射到 PHP 数据传输对象(DTO)。
系统要求
- PHP 8.1 或更高版本
- Composer
- 一个 PSR-18 兼容的 HTTP 客户端(如 Guzzle、Symfony HTTPClient 等)
- PSR-17 兼容的 HTTP 工厂
如果你未提供自有的 HTTP 客户端,本库内置了一个基于 cURL 的简单客户端。
安装
你可以通过 Composer 安装该客户端:
composer require dv-net/php-client
快速开始
基本的客户端初始化
开始使用客户端前,你需要 Merchant API 的 Host 和 API Key。
php
<?php
require 'vendor/autoload.php';
use DvNet\PhpClient\MerchantClient;
use DvNet\PhpClient\Exceptions\DvNetException;
// Replace with your actual host and API key
$host = '[https://your-merchant-api.dv-net.com](https://your-merchant-api.dv-net.com)';
$apiKey = 'your_merchant_api_key_goes_here';
try {
// Initialize the client
// You can optionally pass your own PSR-18 HTTP client and PSR-17 factories
$client = new MerchantClient($host, $apiKey);
// --- Example: Get available currencies ---
$currenciesResponse = $client->getCurrencies();
echo "Successfully fetched " . count($currenciesResponse->getCurrencies()) . " currencies:\n";
foreach ($currenciesResponse->getCurrencies() as $currency) {
echo "- " . $currency->getName() . " (" . $currency->getTicker() . ")\n";
}
// --- Example: Get account balances ---
$balancesResponse = $client->getProcessingWalletBalances();
foreach ($balancesResponse->getProcessingWallets() as $walletBalance) {
echo "Balance for " . $walletBalance->getCurrencyShort()->getTicker() . ": " . $walletBalance->getAsset()->getAmount() . "\n";
}
} catch (DvNetException $e) {
// Catch base exception for all client errors
echo "API Error: " . $e->getMessage() . "\n";
// You can also catch more specific exceptions:
// \DvNet\PhpClient\Exceptions\DvNetInvalidRequestException
// \DvNet\PhpClient\Exceptions\DvNetNetworkException
// \DvNet\PhpClient\Exceptions\DvNetServerException
}处理 Webhook
该库提供了 WebhookMapper,可将来自 DV-NET 的入站 webhook 轻松解析为结构化 DTO。
php
<?php
require 'vendor/autoload.php';
use DvNet\\PhpClient\\WebhookMapper;
use DvNet\\PhpClient\\Dto\\WebhookMapper\\ConfirmedWebhookResponse;
use DvNet\\PhpClient\\Dto\\WebhookMapper\\UnconfirmedWebhookResponse;
use DvNet\\PhpClient\\Dto\\WebhookMapper\\WithdrawalWebhookResponse;
use DvNet\\PhpClient\\Exceptions\\DvNetInvalidWebhookException;
// 1. Get the raw request body
$requestBody = file_get_contents('php://input');
// 2. (Recommended) Verify the signature
// See: /integration/webhook-signature-verification.md
// $signature = $_SERVER['HTTP_X_SIGNATURE_SHA256'];
// $secret = 'your_webhook_secret_key';
// if (!MerchantUtilsManager::verifySignature($requestBody, $signature, $secret)) {
// http_response_code(401);
// echo 'Invalid signature';
// exit;
// }
// 3. Map the webhook payload
$mapper = new WebhookMapper();
try {
$webhook = $mapper->map($requestBody);
// 4. Handle the webhook based on its type
if ($webhook instanceof ConfirmedWebhookResponse) {
// A deposit has been confirmed
$tx = $webhook->getTransaction();
echo "Handling confirmed transaction: " . $tx->getTxid() . " for " . $tx->getAmount() . " " . $tx->getCurrency();
} elseif ($webhook instanceof UnconfirmedWebhookResponse) {
// A new unconfirmed deposit has arrived
$wallet = $webhook->getWallet();
echo "Handling unconfirmed transaction for wallet: " . $wallet->getAddress();
} elseif ($webhook instanceof WithdrawalWebhookResponse) {
// A withdrawal has been processed
$withdrawal = $webhook->getWithdrawal();
echo "Handling withdrawal: " . $withdrawal->getId() . " with status " . $withdrawal->getStatus();
}
// Send a 200 OK response to DV-NET
http_response_code(200);
echo "OK";
} catch (DvNetInvalidWebhookException $e) {
// Payload was not valid JSON or was not a known webhook type
http_response_code(400);
echo "Invalid webhook data: " . $e->getMessage();
}异常处理
客户端抛出的所有异常都继承自基础异常 DvNet\PhpClient\Exceptions\DvNetException。
- DvNetInvalidRequestException:针对 4xx 错误抛出(例如参数错误、认证失败)。
- DvNetServerException:针对服务端 5xx 错误抛出。
- DvNetNetworkException:针对 cURL 或其他网络层错误抛出。
- DvNetInvalidResponseDataException:当服务器响应不是有效的 JSON 或无法映射时抛出。
- DvNetInvalidWebhookException:当负载无效时由 WebhookMapper 抛出。
许可证
本 SDK 以 MIT 许可证发布。