README

Laravel 的 UDS 集成。此包是 UDS 与 Laravel 之间的桥梁。

安装

您可以通过 composer 安装此包

composer require altynbek07/laravel-uds

您应该在 .env 文件中设置以下环境变量

UDS_ID=YourCompanyId
UDS_KEY=YourApiKey

您可以使用以下命令发布配置文件

php artisan vendor:publish --provider="Altynbek07\Uds\UdsServiceProvider" --tag="config"

这是已发布的配置文件内容

<?php

return [
    /**
     * Your company ID from UDS
     */
    'id' => env('UDS_ID'),
    /**
     * Your API Key from UDS
     */
    'key' => env('UDS_KEY'),
    /**
     * This is the API URI path where Uds will be accessible from. Feel free
     * to change this path to anything you like.
     */
    'path' => env('UDS_PATH', 'api/uds'),
    /**
     * These middleware will be assigned to every Uds route, giving you
     * the chance to add your own middleware to this list or change any of
     * the existing middleware. Or, you can simply stick with this list.
     */
    'middleware' => [
        'api',
        // 'auth:api'
    ],
];

使用方法

您可以在任何地方使用 \Altynbek07\Uds\Facades\Uds 中的方法，或者您可以从任何地方发送请求到 API 路由（例如，从前端通过 axios）。

可用方法

获取公司设置

文档：https://docs.uds.app/#tag/Settings

<?php

namespace Altynbek07\Uds\Facades\Uds;

$settings = Uds::settings();

创建交易

文档：https://docs.uds.app/#tag/Operations/paths/~1operations/post

<?php

namespace Altynbek07\Uds\Facades\Uds;

$data = [
    'code' => '3485bf3c-5f9b-42a7-9f25-f102fe464256',
    'receipt' => [
        'total' => 900,
        'cash' => 600,
        'points' => 300
    ]
];

$transaction = Uds::createTransaction($data);

退款交易

文档：https://docs.uds.app/#tag/Operations/paths/~1operations~1{id}~1refund/post

<?php

namespace Altynbek07\Uds\Facades\Uds;

$id = 113327216;

$transaction = Uds::refundTransaction($id);

获取交易信息

文档：https://docs.uds.app/#tag/Operations/paths/~1operations~1calc/post

<?php

namespace Altynbek07\Uds\Facades\Uds;

$data = [
    'code' => '123456',
    'receipt' => [
        'total' => 900,
        'points' => 0
    ]
];

$transaction = Uds::getTransactionInformation($data);

查找客户

文档：https://docs.uds.app/#tag/Customers/paths/~1customers~1find/get

<?php

namespace Altynbek07\Uds\Facades\Uds;

$data = [
    'code' => '123456',
    'exchangeCode' => true
    'total' => 900
];

$customer = Uds::customersFind($data);

获取客户信息

文档：https://docs.uds.app/#tag/Customers/paths/~1customers~1{id}/get

<?php

namespace Altynbek07\Uds\Facades\Uds;

$id = 9099536206450;

$customer = Uds::customers($id);

可用 API 路由

获取公司设置

文档：https://docs.uds.app/#tag/Settings

# GET
/api/uds/settings

创建交易

文档：https://docs.uds.app/#tag/Operations/paths/~1operations/post

# POST
/api/uds/operations

退款交易

文档：https://docs.uds.app/#tag/Operations/paths/~1operations~1{id}~1refund/post

# POST
/api/uds/operations/{id}/refund

获取交易信息

文档：https://docs.uds.app/#tag/Operations/paths/~1operations~1calc/post

# POST
/api/uds/operations/calc

查找客户

文档：https://docs.uds.app/#tag/Customers/paths/~1customers~1find/get

# GET
/api/uds/customers/find?code=123456&exchangeCode=true

获取客户信息

文档：https://docs.uds.app/#tag/Customers/paths/~1customers~1{id}/get

# GET
/api/uds/customers/{id}

测试

composer test

变更日志

有关最近更改的更多信息，请参阅 CHANGELOG。

贡献

有关详细信息，请参阅 CONTRIBUTING。

安全性

如果您发现任何安全相关的问题，请通过电子邮件 altynbek.kazezov.97@gmail.com 联系我们，而不是使用问题跟踪器。

鸣谢

• Altynbek
• 所有贡献者

许可证

MIT 许可证（MIT）。有关更多信息，请参阅 许可证文件。