loyalty php sdk
4.1.0
loyalty php sdk هو أداة للعمل مع برنامج الولاء لتطبيق REST-API Bitrix24 وبطاقات المكافآت لـ Bitrix24 CRM
عبر الملحن
$ composer require b24io/loyalty-php-sdk| الولاء-php-sdk إصدار | حالة الدعم | يبني حالة | واجهة برمجة تطبيقات REST إصدار | PHP الإصدارات |
|---|---|---|---|---|
| v4.x | ؟ نشيط |   | 2 | 8.2 ، 8.3 |
| v3.x | ؟ إصلاح الأخطاء فقط |   | 2 | 7.4 |
| الإصدار 2 | ؟ نهاية الحياة ☠️ | 1 | 7.4 | |
| الإصدار 1 | ؟ نهاية الحياة ☠️ | 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 للمستخدم.
أسطورة
العمل باستخدام البطاقة كدور 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 | ✅ | الحصول على اتصال عن طريق الهوية |
add | ✅ | إضافة جهة اتصال جديدة |
update | ️ | تحديث جهة الاتصال |
delete | ️ | حذف جهة الاتصال |
count | ✅ | عد جهات الاتصال |
startAuthByPhone | ️ | بدء محاولة المصادقة عبر الهاتف |
finishAuth | ️ | إنهاء محاولة المصادقة |
العمل مع جهات الاتصال كدور user
| طريقة | حالة | وصف |
|---|---|---|
getById | ؟ | الحصول على اتصال عن طريق الهوية |
startAuthByPhone | ؟ | بدء محاولة المصادقة عبر الهاتف |
finishAuth | ؟ | إنهاء محاولة المصادقة |
إذا كنت بحاجة إلى تصدير جميع جهات الاتصال، فيمكنك استخدام ContactsFetcher
العمل مع الشركة كدور admin
| طريقة | حالة | وصف |
|---|---|---|
current | الحصول على الشركة الحالية | |
add | ️ | إضافة شركة |
update | ️ | شركة التحديث |
delete | ️ | حذف الشركة |
العمل مع الشركة كدور user
| طريقة | حالة | وصف |
|---|---|---|
current | ؟ | الحصول على الشركة الحالية |
العمل مع مجلة التطبيق كدور admin
| طريقة | حالة | وصف |
|---|---|---|
list | ؟ | الحصول على قائمة عناصر دفتر يومية التطبيق مع التنقل في الصفحة |
getById | ؟ | الحصول على عنصر دفتر يومية التطبيق حسب المعرف |
العمل مع نقاط الاتصال كدور admin
| طريقة | حالة | وصف |
|---|---|---|
list | ؟ | الحصول على قائمة نقاط اللمس مع التنقل في الصفحة |
getById | ؟ | الحصول على عنصر نقطة اللمس عن طريق المعرف |
add | ؟ | إضافة نقطة اتصال جديدة |
update | ️ | تحديث نقطة اللمس |
delete | حذف نقطة اللمس |
أدوات مساعدة لسطر الأوامر للعمل عبر REST-API
php bin/consolecards:export بطاقات الولاء إلى ملف CSVtransactions:bulk-transaction المجمعة المعاملات المجمعة لجميع البطاقات النشطة: الاستحقاق أو الدفعtransactions:load-from-file من ملف CSVtransactions:export المعاملات إلى ملف CSV يتم تتبع الأخطاء وطلب الميزات على GitHub
تشغيل أداة التحليل الثابت
make phpstanإذا اكتشفت أي مشكلات متعلقة بالأمان، فيرجى الاتصال بنا على [email protected]
رخصة معهد ماساتشوستس للتكنولوجيا (MIT). يرجى الاطلاع على ملف الترخيص لمزيد من المعلومات.
