loyalty php sdk

忠诚度-php-sdk

loyalty php sdk是一个与 REST-API Bitrix24 应用程序忠诚度计划和 Bitrix24 CRM 奖金卡配合使用的工具

• 忠诚度应用程序在 CRM 中为 Bitrix24 客户资料添加了奖励卡
• 忠诚度应用程序支持付款和应计操作的交易
• 商店折扣百分比
• 卡片操作：创建、读取、删除、阻止

文档

• REST-API 文档

安装

通过作曲家

$ composer require b24io/loyalty-php-sdk

版本

忠诚度-php-sdk 版本	支持状态	建造 地位	REST API 版本	PHP 版本
v4.x	？积极的		2	8.2 8.3
v3.x	？仅修复错误		2	7.4
v2	？生命的尽头☠️		1	7.4
v1	？生命的尽头☠️		1	7.4

要求

loyalty 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角色使用卡

方法	地位	描述
list	✅	获取带有页面导航的卡片列表
getById	✅	通过uuid获取卡
count	✅️	数卡
delete		通过uuid删除卡
add	✅️	添加新卡
block	️	通过 uuid 阻止卡
unblock	️	通过 uuid 解锁卡
setLevel	️	通过uuid设置卡级别
setPercentage	️	通过uuid设置卡百分比

以user角色使用卡

方法	地位	描述
getById	？	通过uuid获取卡

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

卡牌等级

作为admin角色使用卡级别

方法	地位	描述
list	？	获取卡牌等级列表
add	？	添加新卡牌等级
delete	？	删除卡牌等级
update	️	更新卡牌等级

交易

作为admin角色处理事务。

交易服务包含方法，列表方法与分页一起使用

方法	描述
list	获取所有卡的交易列表并分页
count	计算交易数量
getByCardNumber	获取当前卡号的交易列表
processAccrualTransactionByCardNumber	处理应计交易
processPaymentTransactionByCardNumber	处理付款交易

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

方法	描述
list	获取所有卡的交易列表
listByCardNumber	列出当前卡的所有交易

作为user角色处理事务

方法	地位	描述
getByCardId	？	获取当前卡的交易列表

联系方式

作为admin角色与联系人合作

方法	地位	描述
list	✅	获取联系人列表
getById	✅	通过id获取联系方式
add	✅	添加新联系人
update	️	更新联系方式
delete	️	删除联系人
count	✅	统计联系人数量
startAuthByPhone	️	通过电话开始尝试验证
finishAuth	️	完成身份验证尝试

作为user角色使用联系人

方法	地位	描述
getById	？	通过id获取联系方式
startAuthByPhone	？	通过电话开始尝试验证
finishAuth	？	完成身份验证尝试

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

公司

作为admin角色与公司合作

方法	地位	描述
current		获取当前公司
add	️	添加公司
update	️	更新公司
delete	️	删除公司

作为user角色与公司合作

方法	地位	描述
current	？	获取当前公司

应用期刊

作为admin角色使用申请日志

方法	地位	描述
list	？	获取带有页面导航的应用程序日志项目列表
getById	？	通过 id 获取应用程序日志项目

接触点

作为admin角色使用接触点

方法	地位	描述
list	？	获取带有页面导航的触点列表
getById	？	通过id获取接触点项目
add	？	添加新的接触点
update	️	更新接触点
delete		删除触摸点

基本用法

命令行实用程序

通过 REST-API 进行工作的命令行实用程序

php bin/console

• cards:export将会员卡导出到 csv 文件
• transactions:bulk-transaction对所有活动卡的批量交易：应计或付款
• transactions:load-from-file处理来自 csv 文件的交易
• transactions:export将交易导出到 csv 文件

提交错误和功能请求

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

发展

测试

运行静态分析工具

make phpstan

支持

• [email protected]

安全

如果您发现任何与安全相关的问题，请通过 [email protected] 联系我们

执照

麻省理工学院许可证 (MIT)。请参阅许可证文件以获取更多信息。