API Client

服务端 SDK

API Client

配置环境、超时、重试、日志与代理等 J-Pay Server SDK 客户端选项。

Language

jpay-api/php-sdk

API Client 文档

API Client 支持以下可配置参数：

参数	类型	Description
environment	Environment	The API environment. <br> Default: Environment.PRODUCTION
timeout	int	Timeout for API calls in seconds.<br>Default: 30
enableRetries	bool	Whether to enable retries and backoff feature.<br>Default: false
numberOfRetries	int	The number of retries to make.<br>Default: 0
retryInterval	float	The retry time interval between the endpoint calls.<br>Default: 1
backOffFactor	float	Exponential backoff factor to increase interval between retries.<br>Default: 2
maximumRetryWaitTime	int	The maximum wait time in seconds for overall retrying requests.<br>Default: 0
retryOnTimeout	bool	Whether to retry on request timeout.<br>Default: true
httpStatusCodesToRetry	array	Http status codes to retry against.<br>Default: 408, 413, 429, 500, 502, 503, 504, 521, 522, 524, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524
httpMethodsToRetry	array	Http methods to retry against.<br>Default: 'GET', 'PUT', 'GET', 'PUT'
loggingConfiguration	LoggingConfigurationBuilder	Represents the logging configurations for API calls
proxyConfiguration	ProxyConfigurationBuilder	Represents the proxy configurations for API calls
verifyPeer	bool	Whether to verify SSL certificates.<br>Default: true
verifyHost	bool	Whether to verify SSL host names.<br>Default: true

可按如下方式初始化 API Client：

use JPayApiLib\Logging\LoggingConfigurationBuilder;
use JPayApiLib\Logging\RequestLoggingConfigurationBuilder;
use JPayApiLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use JPayApiLib\Environment;
use JPayApiLib\JPayApiClientBuilder;

$client = JPayApiClientBuilder::init()
    ->environment(Environment::PRODUCTION)
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();

J-Pay API Client

SDK 入口类，用于创建各 API 控制器并持有全局配置。

API 控制器

名称	说明
getAgencyApi()	获取 AgencyApi
getFilesApi()	获取 FilesApi
getPaymentsApi()	获取 PaymentsApi
getPaymentsLinkPaymentApi()	获取 PaymentsLinkPaymentApi
getPayoutsApi()	获取 PayoutsApi