README

为qrstart.eu服务的PHP客户端。

安装

手动下载lib文件夹

https://github.com/foldas/qrstart-php/archive/main.zip

通过composer

composer require foldas/qrstart-php

用法

请求二维码

$data = [
	'type' => 'bank',
	'amount' => 1000,
	'currency' => 'CZK',
	'date' => '20210101',
	'account' => '123456789/6666',
	'note' => 'QR Platba',
	'variable' => '2021',
	'size' => 150
]
$qrstart = new Qr\QrStart('your-api-key');
$response = $qrstart->qrCode($data);

二维码响应

{
	'success': true,
	'url': 'https://api.qrstart.eu/files/abcdefghijklmn.png'
}

请求将二维码添加到PDF文件中

$data = [
	'type' => 'bank',
	'amount' => 1000,
	'currency' => 'CZK',
	'date' => '20210101',
	'account' => '123456789/6666',
	'note' => 'QR Platba',
	'variable' => '2021',
	'size' => 100,
	'file' => '/var/www/your-site/file.pdf',
	'top' => 10,
	'right' => 10
]
$qrstart = new Qr\QrStart('your-api-key');
$response = $qrstart->qrCode($data);

带有二维码的PDF文件响应

{
	'success': true,
	'url': 'https://api.qrstart.eu/files/abcdefghijklmn.pdf'
}

从我们的存储下载二维码（PNG）或PDF文件到您那里。生成的文件将被持续删除。

错误响应

{
	'success': false,
	'message': 'error message'
}

输入参数

• type - 码的类型

  • 可能的值是 bank, ean13, code128, text（默认bank）

• 类型 bank

  • amount - 金额（int或float）
    • 必需
  • currency - CZK或EUR
    • 必需对于CZ/SK银行
    • 对于SEPA银行，货币自动为EUR
  • bank - CZ或SK或SEPA
    • CZ用于捷克QR码，SK用于斯洛伐克QR码（这意味着CZ用于捷克银行应用，SK用于斯洛伐克银行应用）
    • SEPA表示EPC SEPA格式
    • 如果为空，则CZ用于CZK货币，SK用于EUR货币
  • account - 完整的账户号码，包括银行代码（123-456789123/4567）
    • 对于CZK货币
  • iban - IBAN
    • 对于EUR货币必需（或者对于CZK，如果您不想填写账户）
  • swift - SWIFT代码（BIC）
  • variable - 变量符号
  • constant - 固定符号
  • specific - 特定符号
  • note - 对付款人的说明
  • date - 到期日（格式YYYYMMDD）
  • size - 生成的png图像的像素大小（最小50，最大600，默认150）
    • 对于pdf，大小以毫米为单位
  • margin - 图像边距（像素，默认2）
  • tag - 内部说明（在仪表板上可见，最大50个字符）
  • reference - 付款人参考
    • 对于SK银行EUR货币（变量、固定和特定必须为空）
    • 对于SEPA银行
  • beneficiary - 收款人姓名
    • 仅适用于SEPA银行
  • remittance - 汇款说明
    • 仅适用于SEPA银行（参考必须为空）
  • instant 0-1（int）（默认0）
    • 使用1进行即时支付
    • 仅适用于CZ银行

• 类型 ean13

  • code - EAN-13代码
    • 必需
  • size - 1-5（int）（默认2）
    • 对于pdf，大小以毫米为单位
  • tag - 内部说明（在仪表板上可见，最大50个字符）

• 类型 code128

  • code - 一些文本
    • 必需
  • size - 1-5（int）（默认2）
    • 对于pdf，大小以毫米为单位
  • tag - 内部说明（在仪表板上可见，最大50个字符）

• 类型 text

  • code - 一些文本
    • 必需
  • size - 生成的png图像的像素大小（最小50，最大600，默认150）
    • 对于pdf，大小以毫米为单位
  • margin - 图像边距（像素，默认2）
  • tag - 内部说明（在仪表板上可见，最大50个字符）

• 如果您想将二维码放入您的PDF文件中，请添加以下参数

  • file - 服务器上PDF文件的位置
  • top - 从顶部位置（毫米）
  • bottom - 从底部位置（毫米）
    • 在一次请求中，使用顶部或底部
  • left - 从左侧位置（毫米）
  • right - 从右侧位置（毫米）
    • 在一次请求中，使用左侧或右侧
  • page - 图像保存的页面（默认1）
    • 对于最后一页，使用值-1

• 默认情况下，二维码图像以PNG格式生成，但您也可以生成JPG/WEBP格式

  • output - jpg或webp
    • jpg值创建JPG格式的图像
    • webp值创建WEBP格式的图像

帮助

请检查示例文件夹。