README

此包为与 BoxBilling 实例的 API 交互提供了一个简单的接口。

支持通过令牌进行的基本身份验证，用于 Client 和 Admin 端点。

安装

您可以通过 composer 安装此包

composer require nihilsen/laravel-boxbilling

如果您愿意，可以使用以下命令发布配置文件

php artisan vendor:publish --tag="laravel-boxbilling-config"

在发布的配置文件中，您可以配置 BoxBilling 实例的 url 以及认证请求的 token

return [

    /*
    |--------------------------------------------------------------------------
    | Url
    |--------------------------------------------------------------------------
    |
    | The base url for all BoxBilling API requests.
    |
    */

    'url' => env('BOXBILLING_API_URL'),

    /*
    |--------------------------------------------------------------------------
    | Token
    |--------------------------------------------------------------------------
    |
    | The authentication token for authenticated API requests.
    |
    */

    'token' => env('BOXBILLING_API_TOKEN'),

];

或者，您可以通过 .env 环境文件配置这些选项

BOXBILLING_API_URL='https://boxbilling.tld/api'
BOXBILLING_API_TOKEN='your_secret_boxbilling_token'

用法

API 调用遵循与 BoxBilling 内部使用相似的格式。

起始点始终应该是 BoxBilling 门面。

请求参数必须以 命名参数 的形式传递。

use Nihilsen\BoxBilling\Facades\BoxBilling;

# Determine BoxBilling version (endpoint: guest/system/version)
$version = BoxBilling::guest()->system_version();

# Get client by id (endpoint: admin/client/get)
$client = BoxBilling::admin()->client_get(id: 42);

# Get profile of client by id (endpoint: client/profile/get)
$profile = BoxBilling::client(id: 42)->profile_get();

分页结果

分页结果将被收集到 Nihilsen\BoxBilling\Collection 实例中，它是 Illuminate\Support\LazyCollection 的子类。

use Nihilsen\BoxBilling\Facades\BoxBilling;

/** @var Nihilsen\BoxBilling\Collection **/
$tickets = BoxBilling::admin()->support_ticket_get_list(page: 1, per_page: 10);

# Select a random ticket 
$ticket = $tickets->random();