antcool/easy-feieyun

PHP SDK for Feieyun, 飞鹅云, 飞鹅开放平台

1.0.0 2023-04-21 05:31 UTC

Requires

• php: ^8.0.2
• ext-openssl: *
• guzzlehttp/guzzle: ^7.5
• illuminate/collections: ^9.0|^10.0
• monolog/monolog: ^2.5|^3.0
• nyholm/psr7: ^1.6
• nyholm/psr7-server: ^1.0

Requires (Dev)

• symfony/var-dumper: ^6.0

MIT

• 龙权

README

PHP SDK for 飞鹅云

Overtrue! Respect!

文档链接

• 飞鹅云开发文档

安装

$ composer require antcool/easy-feieyun -vvv

使用

配置项

$config = [
    'default'  => 'default',
    'accounts' => [
        'default' => [
            'user'           => '[e-mail]',
            'key'            => '.....',
            'notify_url'     => '', // 打印状态回调地址
            'valid_duration' => 60 * 60 * 2, // 打印订单有效时长, 最大 24 小时
        ],
        
        // 可配置多个账号
        'test' => [
            'user'           => '[e-mail]',
            'key'            => '.....',
            // 其他参数非必须
        ],
    ],

    'public_key' => '', // 飞鹅云公钥文件路径或内容

    'debug'        => true, // 开启将会在 runtime_path 下生成请求日志文件
    'runtime_path' => __DIR__ . '/_runtime',

    'http' => [
        'base_uri' => 'http://api.feieyun.cn/Api/Open/', // 飞鹅云 API 请求 URL
        'timeout'  => 30,
        'verify'   => false,
    ],
];

创建实例

$app = new \AntCool\Feieyun\Application($config);
// 使用其他账号配置
$app->getConfig()->withAccount('test');

$config = $app->getConfig();
$client = $app->getClient();
$server = $app->getServer();

API 调用示范

// 添加打印机
$client->addPrinter(['111111111#xxxxx#测试4G', '22222222#xxxxxx#测试WIFI',])

// 小票打印
$client->printOrder(sn: '', content: '', items: 1, notifyUrl: false, duration: false);

// 标签打印
$client->printLabelOrder(sn: '', content: '', img: '', items: 1, notifyUrl: false, duration: false)

// 批量移除打印机
$client->deletePrinter(sn: 'string|array');

// 编辑打印机信息
$client->editPrinter(sn: '', name: '', phoneNum: '');

// 清除打印机队列
$client->clearPrinterSqs(sn: '');

// 查询订单打印状态
$client->queryOrderStatus(orderId: '');

// 查询指定打印机某天的订单统计数
$client->queryOrderCountByDate(sn: '', date: 'yyyy-mm-dd');

// 获取某台打印机状态
$client->queryPrinterStatus(sn: '');

打印状态回调

$server = $app->getServer();

// 通知内容处理逻辑, 可多次调用
$server->with(function (array $message) {
    // $message 为经过签名验证的通知内容
    
    // $message['orderId'] 订单ID，由接口Open_printMsg返回。
    // $message['status'] 订单状态 	1：打印成功
    // $message['stime'] 订单状态变更UNIX时间戳，10位，精确到秒。
    // $message['sign'] 数字签名
});

// Laravel 内可以直接 return $response
$response = $server->serve();

// 其他需要自己创建响应内容的, 可以参考下面代码
$statusCode = $response->getStatusCode();
foreach ($response->getHeaders() as $name => $values) {
    header(sprintf('%s: %s', $name, implode(', ', $values)), true, $statusCode);
}
echo $response->getBody();

Contributing

You can contribute in one of three ways:

1. ...
2. ...

License

MIT