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 ext-jsonおよびext-curlサポートが必要です

管理者ロールとユーザーロールによる認証

SDK は 2 つの役割で動作できます。

• 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を使用できます。すべてのフェッチャー メソッドはジェネレーターを返しますが、フェッチャーの内部ではページネーションが使用されます。

方法	説明
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
• transactions:bulk-transactionすべてのアクティブなカードへの一括トランザクション: 見越または支払い
• transactions:load-from-file CSV ファイルからトランザクションを処理する
• transactions:export

バグと機能リクエストの送信

バグと機能リクエストは GitHub で追跡されます

発達

テスト

静的解析ツールを実行する

make phpstan

サポート

• [email protected]

安全

セキュリティ関連の問題を発見した場合は、[email protected] までご連絡ください。

ライセンス

MIT ライセンス (MIT)。詳細については、ライセンス ファイルを参照してください。