loyalty php sdk下載 - loyalty php sdk源碼下載

loyalty php sdk

其他類別

4.1.0

下載

忠誠度-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`
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`		刪除觸摸點