README

A Kirby 插件，用于连接到 Stripe。

安装

下载

下载并将此存储库复制到 /site/plugins/kirby-stripe。

Git 子模块

git submodule add https://github.com/tristantbg/kirby-stripe.git site/plugins/kirby-stripe

Composer

composer require tristantbg/kirby-stripe

配置

在 Kirby 插件根目录添加一个 .env 文件，包含以下属性

Kirby 配置默认值

'tristantbg.kirby-stripe' => [
    'test_mode' => false,
    'payment_method_types' => ['card'],
    'automatic_tax' => true,
    'allowed_countries' => [
      'FR',
      'US',
      'CA',
      'GB',
      'IT',
      'ES',
      'DE',
      'MF',
      'PM',
      'RE',
      'MC',
      'MQ',
      'LU',
      'LI',
      'GG',
      'GP',
      'GR',
      'FI',
      'DK',
      'BE'
    ],
    'shipping_rate_data' => [
      'type' => 'fixed_amount',
      'tax_behavior' => 'inclusive',
      'fixed_amount' => [
        // Amount*100 = 5€ => 500
        'amount' => 500,
        'currency' => 'eur',
      ],
      'display_name' => 'Standard shipping',
      // Delivers between 5-7 business days
      'delivery_estimate' => [
        'minimum' => [
          'unit' => 'business_day',
          'value' => 5,
        ],
        'maximum' => [
          'unit' => 'business_day',
          'value' => 7,
        ],
      ]
    ]
  ]

使用插件

API 密钥

为了让插件工作，您需要在此处获取密钥 https://dashboard.stripe.com/apikeys

注意： 此插件还包括一个 .env.example 文件。

方法

使用 Stripe PHP 客户端进行自定义查询

$stripe_client = KirbyStripe\Auth::stripeClient();
$products = $stripe_client->products->all(['limit' => 100])['data'];

获取所有价格

KirbyStripe\Methods::getPrices($search = 'optional query')

获取所有产品

KirbyStripe\Methods::getProducts($search = 'optional query')

查询使用 Stripe 查询语言

示例

$search = "active:'true' AND name~'name of product'"

https://stripe.com/docs/search#search-query-language

路由端点

https://site.url/sck/api/prices

https://site.url/sck/api/products

https://site.url/sck/checkout/{{kirbyProductPageUid}}

https://site.url/sck/checkout/price/{{stripePriceId}}

PRICE_ID KIRBY 字段

轻松将 Kirby 页面连接到产品的 Stripe price_id

stripePriceID:
  extends: fields/stripe-price-id

插件开发

Kirbyup 用于开发和构建设置。

Kirbyup 将在您的第一次 npm run 命令中远程获取，这可能需要一些时间。

开发

使用以下命令开始开发过程

npm run dev

这将自动在插件更改时更新 index.js 和 index.css。重新加载面板以查看代码更改。

生产

使用以下命令构建最终文件

npm run build

这将自动创建 index.js 和 index.css 的最小化和优化版本。

许可证

MIT

tristantbg / kirby-stripe

维护者

详细信息