README

忠诚度PHP SDK是一个用于与Bitrix24应用程序的REST-API（[Loyalty Program and bonus cards for Bitrix24 CRM](https://www.bitrix24.ru/apps/?app=b24io.loyalty)）工作的工具。

忠诚度应用在CRM中为Bitrix24客户资料添加奖励卡
忠诚度应用支持支付和累积操作的交易
存储折扣百分比
卡片操作：创建、读取、删除、锁定

文档

REST-API文档

安装

通过Composer

$ composer require b24io/loyalty-php-sdk

版本

要求

忠诚度PHP SDK与PHP 8.2或更高版本兼容，需要支持ext-json和ext-curl

使用管理员和用户角色进行身份验证

SDK可以与两个角色一起工作

admin - 可以处理其账户中所有卡片和忠诚度应用程序实例中的所有卡片
user - 只能处理自己的卡片

我们与许多账户合作，每个账户都有一个CLIENT_API_KEY。如果您想以管理员角色工作，您必须使用ADMIN_API_KEY来签名查询。如果您想在JS中以客户端角色工作，您必须使用CLIENT_API_KEY和CARD_UUID作为用户API密钥。

从REST-API可用的域实体

图例

✅ — 通过rest-api可用，并在PHP-SDK中实现
🛠 — 通过rest-api可用，但在PHP-SDK中未实现
❌ — 在rest-api中未实现

卡片

以admin角色处理卡片

以user角色处理卡片

如果您需要导出所有卡片，您可以使用CardsFetcher

卡片等级

以admin角色处理卡片等级

交易

以admin角色处理交易。

交易服务包含方法，list方法支持分页

如果您想在不分页的情况下读取所有交易，您可以使用TransactionsFetcher。所有fetcher方法都返回生成器，底层fetcher使用分页。

以user角色处理交易

联系人

以admin角色处理联系人

以user角色处理联系人

如果您需要导出所有联系人，您可以使用ContactsFetcher

公司

以admin角色处理公司

以user角色处理公司

应用程序日志

以admin角色处理应用程序日志

触点

以admin角色处理触点

基本用法

命令行工具

用于通过REST-API工作的命令行工具

php bin/console

cards:export 将忠诚度卡片导出到csv文件
transactions:bulk-transaction 对所有活动卡片执行批量交易：累积或支付
transactions:load-from-file 从csv文件处理交易
transactions:export 将交易导出到csv文件

提交错误和功能请求

错误和功能请求在GitHub上跟踪

开发

测试

运行静态分析工具

make phpstan

支持

app@b24.io

安全性

如果您发现任何与安全相关的问题，请通过app@b24.io联系我们

许可证

MIT许可证（MIT）。请参阅许可证文件获取更多信息。

b24io / loyalty-php-sdk

维护者

详细信息