ดาวน์โหลด loyalty php sdk - ดาวน์โหลด loyalty php sdk ซอร์สโค้ด

loyalty php sdk

หมวดหมู่อื่นๆ

4.1.0

ดาวน์โหลด

ความภักดี-php-sdk

loyalty php sdk เป็นเครื่องมือสำหรับการทำงานร่วมกับ REST-API Bitrix24 Application Loyalty Program และบัตรโบนัสสำหรับ Bitrix24 CRM

แอปความภักดีเพิ่มการ์ดโบนัสสำหรับโปรไฟล์ลูกค้า Bitrix24 ใน CRM
แอปสะสมคะแนนรองรับธุรกรรมสำหรับการชำระเงินและการดำเนินการคงค้าง
เปอร์เซ็นต์ส่วนลดของร้านค้า
การดำเนินการกับการ์ด: สร้าง อ่าน ลบ บล็อก

เอกสารประกอบ

เอกสารประกอบ REST-API

การติดตั้ง

ผ่านทางผู้แต่ง

$ composer require b24io/loyalty-php-sdk

รุ่นต่างๆ

ความภักดี-php-sdk รุ่น	สถานะการสนับสนุน	ส่วนที่เหลือ-API รุ่น	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 ของผู้ใช้

เอนทิตีโดเมนพร้อมใช้งานจาก REST-API

ตำนาน

✅ — ใช้งานได้ผ่าน wia rest-api และใช้งานใน PHP-SDK
- — ใช้งานได้ผ่าน wia rest-api และ ไม่ ได้ใช้งานใน PHP-SDK
— ไม่ได้นำไปใช้ในส่วนที่เหลือ-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`		ติดต่อได้ที่ไอดี
`add`		เพิ่มผู้ติดต่อใหม่
`update`		อัปเดตรายชื่อติดต่อ
`delete`		ลบผู้ติดต่อ
`count`		นับผู้ติดต่อ
`startAuthByPhone`		เริ่มความพยายามตรวจสอบสิทธิ์ทางโทรศัพท์
`finishAuth`		เสร็จสิ้นความพยายามตรวจสอบสิทธิ์

ทำงานกับผู้ติดต่อในฐานะบทบาท user

วิธี	สถานะ	คำอธิบาย
`getById`	-	ติดต่อได้ที่ไอดี
`startAuthByPhone`	-	เริ่มความพยายามตรวจสอบสิทธิ์ทางโทรศัพท์
`finishAuth`	-	เสร็จสิ้นความพยายามตรวจสอบสิทธิ์

หากคุณต้องการส่งออกรายชื่อติดต่อทั้งหมด คุณสามารถใช้ ContactsFetcher ได้

บริษัท

ทำงานร่วมกับบริษัทในฐานะ admin

วิธี	สถานะ	คำอธิบาย
`current`		รับบริษัทปัจจุบัน
`add`		เพิ่มบริษัท
`update`		อัปเดตบริษัท
`delete`		ลบบริษัท

ทำงานร่วมกับบริษัทในฐานะ user

วิธี	สถานะ	คำอธิบาย
`current`	-	รับบริษัทปัจจุบัน

ApplicationJournal

ทำงานกับ Application Journal ในฐานะ admin

วิธี	สถานะ	คำอธิบาย
`list`	-	รับรายการบันทึกประจำวันของแอปพลิเคชันพร้อมการนำทางหน้า
`getById`	-	รับรายการบันทึกประจำวันของแอปพลิเคชันด้วยรหัส

จุดสัมผัส

ทำงานร่วมกับจุดสัมผัสในฐานะบทบาท admin

วิธี	สถานะ	คำอธิบาย
`list`	-	รับรายการจุดสัมผัสพร้อมการนำทางหน้า
`getById`	-	รับรายการจุดสัมผัสด้วยรหัส
`add`	-	เพิ่มจุดสัมผัสใหม่
`update`		อัปเดตจุดสัมผัส
`delete`		ลบจุดสัมผัส

การใช้งานขั้นพื้นฐาน

ยูทิลิตี้บรรทัดคำสั่ง

ยูทิลิตี้บรรทัดคำสั่งสำหรับการทำงานผ่าน REST-API

php bin/console

cards:export ส่งออกบัตรสะสมคะแนนเป็นไฟล์ csv
transactions:bulk-transaction จำนวนมากไปยังบัตรที่ใช้งานอยู่ทั้งหมด: เงินคงค้างหรือการชำระเงิน
transactions:load-from-file ประมวลผลธุรกรรมจากไฟล์ csv
transactions:export ส่งออกธุรกรรมเป็นไฟล์ CSV