0ctobat/octobat-php

Octobat PHP 库

2.4.0 2021-05-06 15:34 UTC

This package is auto-updated.

Last update: 2024-09-06 22:30:14 UTC


README

您可以在 https://www.octobat.com 上注册 Octobat 账户。

要求

PHP 5.4.0 及以上版本。

Composer

您可以通过 Composer 安装这些绑定。运行以下命令

composer require 0ctobat/octobat-php

要使用这些绑定,请使用 Composer 的 自动加载

require_once('vendor/autoload.php');

手动安装

如果您不想使用 Composer,可以下载最新的 版本。然后,为了使用绑定,请包含 init.php 文件。

require_once('/path/to/octobat-php/init.php');

依赖

为了正确工作,这些绑定需要以下扩展

  • curl,尽管您可以选择使用自己的非 cURL 客户端
  • json
  • mbstring(多字节字符串)

如果您使用 Composer,这些依赖项应自动处理。如果您手动安装,请确保这些扩展可用。

入门

简单用法如下

\Octobat\Octobat::setApiKey('sk_test_BQokikJOvBiI2HlWgH4olfQ2');
$customer = \Octobat\Customer::create(['email' => "john.doe@gmail.com", 'name' => 'John Doe', 'billing_address_country' => 'FR']);
echo $customer;

文档

请参阅 http://v2apidoc.octobat.com/ 获取最新文档。

配置记录器

库执行最少的日志记录,但它可以通过与 PSR-3 兼容的记录器进行配置,以便消息最终显示在那里而不是 error_log

\Octobat\Octobat::setLogger($logger);

按请求配置

对于需要在整个进程生命周期中使用多个密钥的应用程序,还可以设置每个请求的密钥和/或账户

\Octobat\Customer::all([], [
    'api_key' => 'oc_test_skey...'
]);

\Octobat\Customer::retrieve("oc_cu_xxxxxxxx", [
    'api_key' => 'oc_test_skey...'
]);