Recurly PHP客户端技术文档
1. 安装指南
1.1 使用Composer安装
Recurly PHP客户端通过Packagist发布,包名为recurly/recurly-client。推荐使用Composer来安装和维护该依赖。
在项目的composer.json文件中添加以下内容:
{
"require": {
"recurly/recurly-client": "^4"
}
}
然后运行以下命令进行安装:
composer install
1.2 注意事项
- Recurly PHP客户端遵循语义化版本控制(Semantic Versioning),只有在主版本更新时才会引入破坏性更改。
- 如果你需要使用V2版本的客户端,请参考v2分支。
2. 项目的使用说明
2.1 创建客户端
在使用Recurly API之前,首先需要创建一个客户端实例。客户端的构造函数需要一个API密钥,该密钥可以在Recurly的API Credentials Page获取。
$api_key = 'myApiKey';
$client = new \Recurly\Client($api_key);
如果你在欧洲地区使用Recurly API,需要在选项中指定region为eu:
$api_key = 'myApiKey';
$client = new \Recurly\Client($api_key, ['region' => 'eu']);
2.2 日志记录
客户端的构造函数还支持传入一个日志记录器。日志记录器需要实现PSR-3 Logger Interface。默认情况下,客户端会创建一个\Recurly\Logger实例,该实例会将日志消息打印到php://stdout,日志级别为\Psr\Log\LogLevel::WARNING。
$logger = new \Recurly\Logger('Recurly', \Psr\Log\LogLevel::INFO);
$client = new \Recurly\Client($api_key, $logger);
安全警告:在生产环境中,日志级别不应设置为DEBUG,否则可能会导致敏感数据泄露。
2.3 操作方法
\Recurly\Client类包含了所有可以在Recurly API上执行的操作方法。每个方法都有详细的文档说明,解释了输入和返回类型的类型和描述。例如,要使用get_plan端点,可以调用Client#getPlan()方法:
$plan_code = "gold";
$plan = $client->getPlan("code-$plan_code");
2.4 分页处理
分页通过\Recurly\Pager对象实现。Pager对象由客户端的list*方法创建,并实现了PHP的Iterator接口,因此可以在foreach循环中使用。
$accounts = $client->listAccounts();
foreach($accounts as $account) {
echo 'Account code: ' . $account->getCode() . PHP_EOL;
}
2.5 排序和过滤
在调用list*方法时,可以传入选项参数来进行排序或过滤。这些参数在方法文档中有所描述,可以在Recurly API文档的“Query Parameters”部分找到。
$options = array('params' => array(
'limit' => 200,
'order' => 'asc',
'begin_time' => '2020-01-01T01:00:00Z',
'end_time' => '2020-02-01T01:00:00Z',
'email' => 'admin@email.com',
'subscriber' => true,
'past_due' => false
));
$accounts = $client->listAccounts($options);
foreach($accounts as $account) {
echo 'Account code: ' . $account->getCode() . PHP_EOL;
}
2.6 资源计数
Pager类实现了getCount()方法,可以获取Pager对象将返回的资源总数。该方法通过调用端点的HEAD请求并解析Recurly-Total-Records头来实现。
$accounts = $client->listAccounts([ 'past_due' => true ]);
$count = $accounts->getCount();
echo "Number of accounts past due: $count"
2.7 高效获取第一个或最后一个资源
Pager类还实现了getFirst()方法,可以高效地获取第一个或最后一个资源。
$accounts = $client->listAccounts([ 'order' => 'desc', 'past_due' => true ]);
$account = $accounts->getFirst();
3. 项目API使用文档
3.1 创建资源
对于创建或更新资源,可以传入一个普通的关联数组给create*或update*方法。
$plan_create = array(
"name" => "Monthly Coffee Subscription",
"code" => "coffee-monthly",
"currencies" => [
array(
"currency" => "USD",
"unit_amount" => 20.0
)
]
);
$plan = $client->createPlan($plan_create);
echo 'Created Plan:' . PHP_EOL;
var_dump($plan);
3.2 错误处理
在调用API时,可能会遇到各种错误。可以通过捕获异常来处理这些错误。
try {
$account = $client->deactivateAccount($account_id);
} catch (\Recurly\Errors\Validation $e) {
var_dump($e);
} catch (\Recurly\Errors\NotFound $e) {
var_dump($e);
} catch (\Recurly\RecurlyError $e) {
var_dump($e);
}
3.3 HTTP元数据
有时你可能需要获取底层HTTP请求和响应的额外信息。可以通过调用getResponse()方法来访问这些信息。
$account = $client->getAccount("code-douglas");
$response = $account->getResponse();
echo "Request ID:" . $response->getRequestId() . PHP_EOL;
echo "Rate limit remaining:" . $response->getRateLimitRemaining() . PHP_EOL;
4. 项目安装方式
项目通过Composer进行安装,具体步骤请参考安装指南。
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCR暂无简介Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile013
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00