README

Checkbox.ua 的 PHP SDK

1. 安装
2. 用法
3. 收银员
   1. 使用当前访问令牌完成收银员会话
   2. 获取当前用户（收银员）的信息
   3. 接收关于活动用户（收银员）更改的信息
   4. 检查签名
4. 组织
   1. 获取当前组织的收据设置
   2. 获取当前组织的标志
   3. 获取当前组织的文本标志
5. 班次
   1. 通过用户（收银员）创建 Z-报告并关闭当前班次
   2. 收银员打开新班次
   3. 获取当前收银员班次
   4. 接收当前班次信息

安装

推荐通过 Composer 安装 Guzzle。

composer require tdev-agency/checkbox-ua

用法

创建 SignIn 实体

1. 使用登录名和密码进行登录

$entity = \TDevAgency\CheckboxUa\Entities\Requests\SignInRequestEntity::create([
            'login' => 'login',
            'password' => 'password',
            'license_key' => 'license_key'
]);

1. 使用 PIN 码进行登录

$entity = \TDevAgency\CheckboxUa\Entities\Requests\SignInRequestEntity::create([
            'pin_code' => 'pin_code',
            'license_key' => 'license_key'
]);

初始化 checkbox.ua 实例

// For pin code sign in
$client = new CheckboxUa(CheckboxUa::DRIVER_SIGNIN_PIN_CODE, $entity);
// For sign in with login and password
$client = new CheckboxUa(CheckboxUa::DRIVER_SIGNIN, $entity);

API 端点标签

基于 checkbox.ua 的官方文档的标签

调用所需标签有两种方式。

例如： $cashier = $client->getCashier(); 或使用辅助方法 $cashier = $client->make(\TDevAgency\CheckboxUa\Tags\Cashier::class);

收银员

使用当前访问令牌完成收银员会话

$client->getCashier()->signOut()

获取当前用户（收银员）的信息

$client->getCashier()->me()

接收关于活动用户（收银员）更改的信息

$client->getCashier()->shift()

检查签名

$client->getCashier()->checkSignature()

组织

获取当前组织的收据设置

$client->make(\TDevAgency\CheckboxUa\Tags\Organization::class)->receiptConfig()

获取当前组织的标志

$client->make(\TDevAgency\CheckboxUa\Tags\Organization::class)->logoPng()

获取当前组织的文本标志

$client->make(\TDevAgency\CheckboxUa\Tags\Organization::class)->textLogoPng()

班次

通过用户（收银员）创建 Z-报告并关闭当前班次

$client->make(\TDevAgency\CheckboxUa\Tags\Shifts::class)->closeShift()

可选地，可以在客户端生成 Z-报告并将其作为此请求的正文传递

$entity = \TDevAgency\CheckboxUa\Entities\Requests\ShiftCloseRequestEntity::create($data)
$client->make(\TDevAgency\CheckboxUa\Tags\Shifts::class)->closeShift($entity)

$data 值

收银员打开新班次

$client->make(\TDevAgency\CheckboxUa\Tags\Shifts::class)->createShift($id, $fiscal_code, $fiscal_date)

获取当前收银员班次

$client->make(\TDevAgency\CheckboxUa\Tags\Shifts::class)->getShifts($statuses, $limit, $offset, $desc)

接收当前班次信息

$client->make(\TDevAgency\CheckboxUa\Tags\Shifts::class)->getShift($id, $options)

收据

获取当前班次内或根据筛选参数的检查列表

$entity = \TDevAgency\CheckboxUa\Entities\Requests\ReceiptQueryRequestEntity::create($data)
$client->getReceipts()->index($requestEntity)

$data 参数用于 ReceiptQueryRequestEntity

待办事项

1. 创建收据
2. 获取收据 HTML
3. Webhooks