josan-br/laravel-galax-pay

向Galax Pay API发起请求

V4.0.2 2023-06-23 15:01 UTC

README

Laravel的Galax Pay API包装器

安装

步骤 1. 将Laravel Galax Pay添加到项目中

composer require josan-br/laravel-galax-pay

步骤 2. 注册GalaxPayServiceProvider

  • 在Laravel中

    'providers' => [
        // ...
        \JosanBr\GalaxPay\Providers\GalaxPayServiceProvider::class,
    ];
  • 在Lumen中,转到bootstrap/app.php文件,并在提供者部分添加

    $app->register(\JosanBr\GalaxPay\Providers\GalaxPayServiceProvider::class);

步骤 3. 发布文件

php artisan galax-pay:publish

此命令允许发布设置和迁移,在发布迁移之前先发布设置。

命令不会同时发布两者,因为您可能想使用除包提供的表之外的其他表。

在这种情况下,只需转到config/galax_pay.php并定义您想要使用的模型和相应的列。

// ...
'galax_pay_clients' => [
    'ref'          => \JosanBr\GalaxPay\Models\GalaxPayClient::class,
    // Columns
    'model_type'   => 'model_type',
    'model_id'     => 'model_id',
    'galax_id'     => 'galax_id',
    'galax_hash'   => 'galax_hash',
    'webhook_hash' => 'webhook_hash',
],

'galax_pay_sessions' => [
    'ref'          => \JosanBr\GalaxPay\Models\GalaxPaySession::class,
    // Columns
    'scope'        => 'scope',
    'expires_in'   => 'expires_in',
    'token_type'   => 'token_type',
    'access_token' => 'access_token',
    'client_id'    => 'galax_pay_client_id',
]

步骤 4. 添加环境变量

php artisan galax-pay:publish

并选择:环境变量

What will be published?:
[0] config
[1] environment variables
[2] migrations
> environment variables

用法

使用Galax Pay外观类

use JosanBr\GalaxPay\Facades\GalaxPay;

如果使用标准身份验证,auth_as_partner = false,只需调用一个端点作为静态函数

$data = GalaxPay::listCustomers();

如果使用auth_as_partner = true合作伙伴身份验证,必须将客户端的galax_id作为参数传递

$data = GalaxPay::listCustomers([], ['client_galax_id' => $clientGalaxId]);

您可以在此处查看所有端点。

所有端点接收一个数组类型的函数参数,其格式如下

/**
 * GET example
 * 
 * @var array|\JosanBr\GalaxPay\QueryParams $queryParams
 * @var array|\JosanBr\GalaxPay\Http\Options $options
 */

$res = GalaxPay::listCustomers($queryParams, $options);

/**
 * POST example
 * 
 * @var array|\JosanBr\GalaxPay\Abstracts\Model $data
 * @var array|\JosanBr\GalaxPay\Http\Options $options
 */

$res = GalaxPay::createCustomer($data, $options);

/**
 * PUT example
 * 
 * @var int|string $id
 * @var array|\JosanBr\GalaxPay\Abstracts\Model $data
 * @var array|\JosanBr\GalaxPay\Http\Options $options
 */

$res = GalaxPay::editCustomer($id, $data, $options);

/**
 * DELETE example
 * 
 * @var int|string $id
 * @var array|\JosanBr\GalaxPay\Http\Options $options
 */

$res = GalaxPay::deleteCustomer($id, $options);

QueryParams类只有数据获取端点之间的通用参数,要查看每个端点接受的全部参数,请查阅Galax Pay文档