komtet/kassa-sdk

Komtet Kassa 的 PHP SDK

10.0.0 2024-09-16 07:47 UTC

README

库,用于将您的网站集成到 Komtet 云打印服务

要求

  • PHP >= 7.2
  • CURL

安装

使用 Composer

composer require komtet/kassa-sdk

手动

git clone https://github.com/Komtet/komtet-kassa-php-sdk
<?php

require __DIR__.'/komtet-kassa-php-sdk/autoload.php';

使用 php-cli 从 examples 发送示例

make build
make cli_php_7 или make cli_php_8
php -f examples/v1/send_check_example.php

使用 v1

首先,需要创建队列管理器

<?php

use Komtet\KassaSdk\v1\Client;
use Komtet\KassaSdk\v1\QueueManager;

$key = 'идентификатор магазина';
$secret = 'секретный ключ';
// PSR-совместимый логгер (опциональный параметр)
$logger = null;
$client = new Client($key, $secret, $logger);
$manager = new QueueManager($client);

之后,注册队列

$manager->registerQueue('queue-name-1', 'queue-id-1');
$manager->registerQueue('queue-name-2', 'queue-id-2');
// 'queue-name-1' и 'queue-name-2' - произвольные псевдомимы для обращения к очередям.
// 'queue-id-1' и 'queue-id-2' - идентификаторы очередей, созданных в личном кабинете.

收据

发送收据打印 - 示例

发送修正收据打印 - 示例

为了不每次都指定队列名称,设置默认队列

<?php

$manager->setDefaultQueue('queue-name-1');
$manager->putCheck($check);

获取队列状态

<?php

$manager->isQueueActive('queue-name-1');

获取已提交至 fiscalization 的任务的详细信息

<?php

$taskManager = new TaskManager($client);
try {
    $taskManager->getTaskInfo('task-id');
} catch (SdkException $e) {
    echo $e->getMessage();
}

订单

创建配送订单 - 示例

更新配送订单

<?php

$orderManager = new OrderManager($client);
$order_id = 1;

$order = new Order('123', TaxSystem::COMMON, 'new', 0);
$order->setClient('г.Пенза, ул.Суворова д.10 кв.25',
                  '+87654443322',
                  'client@email.com',
                  'Сергеев Виктор Сергеевич');
$order->setDeliveryTime('2018-02-28 14:00',
                        '2018-02-28 15:20');
$orderPosition = new OrderPosition(['oid' => '1',
                                    'name' => 'position name1',
                                    'price' => 555.0,
                                    'type' => 'product'
                                    ]);
$order->addPosition($orderPosition);

try {
    $orderManager->updateOrder($order_id, $order);
} catch (SdkException $e) {
    echo $e->getMessage();
}

订单信息

<?php

$orderManager = new OrderManager($client);
$order_id = 1;

try {
  $info = $orderManager->getOrderInfo($order_id);
} catch (SdkException $e) {
    echo $e->getMessage();
}

在订单上应用全局折扣

<?php

$discount = 250;
$order->applyDiscount($discount);

删除订单

<?php

$orderManager = new OrderManager($client);
$order_id = 1;

try {
  $orderManager->deleteOrder($order_id);
} catch (SdkException $e) {
    echo $e->getMessage();
}

获取订单列表

<?php

$orderManager = new OrderManager($client);

try {
    $orderList = $orderManager->getOrders();
} catch (SdkException $e) {
    echo $e->getMessage();
}

获取员工列表

<?php

use Komtet\KassaSdk\EmployeeManager;
use Komtet\KassaSdk\EmployeeType;

$employeeManager = new EmployeeManager(client);

try {
    $employeeList = $employeeManager->getEmployees(EmployeeType::COURIER);
} catch (SdkException $e) {
    echo $e->getMessage();
}

获取员工信息

<?php

$employeeManager = new EmployeeManager(client);
$employeeID = 1;

try {
    $employee = $employeeManager->getEmployee($employeeID);
} catch (SdkException $e) {
    echo $e->getMessage();
}

创建员工

<?php

$employeeManager = new EmployeeManager(client);
$employee = new Employee(EmployeeType::CASHIER, 'Full Name', 
                         'login_employee', 'password', 'POS_KEY');
$employee->setPaymentAddress('payment address');
$employee->setAccessSettings(true, false, none);

try {
    $employeeManager->createEmployee($employee);
} catch (SdkException $e) {
    echo $e->getMessage();
}

更新员工

<?php

$employeeManager = new EmployeeManager(client);
$employee = new Employee(EmployeeType::CASHIER, 'Full Name', 
                         'login_employee', 'new_password', 'POS_KEY');
$employee->setPaymentAddress('new payment address');
$employee->setAccessSettings(true, true, true);

$employeeID = 1;

try {
    $employeeManager->updateEmployee($employeeID, $employee);
} catch (SdkException $e) {
    echo $e->getMessage();
}

删除员工

<?php

$employeeManager = new EmployeeManager(client);
$employeeID = 1;

try {
    $employeeManager->deleteEmployee($employeeID);
} catch (SdkException $e) {
    echo $e->getMessage();
}

使用 v2

首先,需要创建队列管理器

<?php

use Komtet\KassaSdk\v2\Client;
use Komtet\KassaSdk\v2\QueueManager;

$key = 'идентификатор магазина';
$secret = 'секретный ключ';
// PSR-совместимый логгер (опциональный параметр)
$logger = null;
$client = new Client($key, $secret, $logger);
$manager = new QueueManager($client);

之后,注册队列

$manager->registerQueue('queue-name-1', 'queue-id-1');
$manager->registerQueue('queue-name-2', 'queue-id-2');
// 'queue-name-1' и 'queue-name-2' - произвольные псевдомимы для обращения к очередям.
// 'queue-id-1' и 'queue-id-2' - идентификаторы очередей, созданных в личном кабинете.

收据

发送收据打印 - 示例

发送修正收据打印 - 示例

为了不每次都指定队列名称,设置默认队列

<?php

$manager->setDefaultQueue('queue-name-1');
$manager->putCheck($check);

获取队列状态

<?php

$manager->isQueueActive('queue-name-1');

获取已提交至 fiscalization 的任务的详细信息

<?php

$taskManager = new TaskManager($client);
try {
    $taskManager->getTaskInfo('task-id');
} catch (SdkException $e) {
    echo $e->getMessage();
}

订单

创建配送订单 - 示例

更新配送订单

<?php

$orderManager = new OrderManager($client);
$order_id = 1;

$order = new Order('12345', 'new', true);

$orderCompany = new OrderCompany(TaxSystem::COMMON, 'Улица Московская д.4');
$order->setCompany($orderCompany);

$orderBuyer = new OrderBuyer('+87654443322', 
                             'г.Пенза, ул.Суворова д.10 кв.25')
$order->setOrderBuyer($orderBuyer);

$order->setDeliveryTime('20.02.2022 14:00',
                        '20.02.2022 15:20');

$orderPosition = new OrderPosition(['name' => 'position name1',
                                    'price' => 555.0,
                                    'quantity' => 1,
                                    'total' => 555.0,
                                    'vat' => '20',
                                    ]);
$order->addPosition($orderPosition);

try {
    $orderManager->updateOrder($order_id, $order);
} catch (ApiValidationException $e) {
    echo $e->getMessage();
    echo $e->getVLDCode();
    echo $e->getDescription();
} catch (SdkException $e) {
    echo $e->getMessage();
}

API v2 的以下操作与 API v1 的调用相同(示例在上文 API v1 描述中提供)

  • 订单信息
  • 在订单上应用全局折扣
  • 删除订单
  • 获取订单列表
  • 获取员工列表
  • 获取员工信息
  • 创建员工
  • 更新员工
  • 删除员工