Unduhan loyalty php sdk - unduhan kode sumber loyalty php sdk

loyalty php sdk

Kategori lainnya

4.1.0

Unduh

loyalitas-php-sdk

loyalty php sdk adalah alat untuk bekerja dengan Program Loyalitas Aplikasi Bitrix24 REST-API dan kartu bonus untuk Bitrix24 CRM

Aplikasi loyalitas menambahkan kartu bonus untuk profil klien Bitrix24 di CRM
Aplikasi loyalitas mendukung transaksi untuk pembayaran dan operasi akrual
persentase diskon toko
operasi dengan kartu: membuat, membaca, menghapus, memblokir

Dokumentasi

Dokumentasi REST-API

Instalasi

Melalui Komposer

$ composer require b24io/loyalty-php-sdk

Versi

loyalitas-php-sdk versi	status dukungan	REST-API versi	PHP versi
v4.x	? aktif	2	`8.2` , `8.3`
v3.x	? perbaikan bug saja	2	`7.4`
v2	? akhir hidup ☠️	1	`7.4`
v1	? akhir hidup ☠️	1	`7.4`

Persyaratan

loyalty php sdk berfungsi dengan PHP 8.2 atau lebih tinggi, memerlukan dukungan ext-json dan ext-curl

Otentikasi dengan peran admin dan pengguna

SDK dapat bekerja dengan dua peran:

admin - dapat bekerja dengan semua kartu di akunnya dan contoh aplikasi loyalitas
user - hanya dapat bekerja dengan kartunya sendiri

Kami bekerja dengan banyak akun, setiap akun memiliki CLIENT_API_KEY Jika Anda ingin bekerja sebagai admin, Anda harus menggunakan ADMIN_API_KEY untuk menandatangani kueri. Jika Anda ingin bekerja dengan peran klien di JS, Anda harus menggunakan CLIENT_API_KEY dan CARD_UUID sebagai kunci API pengguna.

Entitas domain tersedia dari REST-API

Legenda

✅ — tersedia melalui rest-api dan diimplementasikan dalam PHP-SDK
? — tersedia melalui rest-api dan tidak diterapkan di PHP-SDK
— tidak diterapkan di rest-api

Kartu-kartu

Bekerja dengan kartu sebagai peran admin

Metode	Status	Keterangan
`list`	✅	dapatkan daftar kartu dengan navigasi halaman
`getById`	✅	dapatkan kartu melalui uuid
`count`	✅️	menghitung kartu
`delete`		hapus kartu oleh uuid
`add`	✅️	tambahkan kartu baru
`block`	️	blok kartu oleh uuid
`unblock`	️	buka blokir kartu dengan uuid
`setLevel`	️	atur level kartu dengan uuid
`setPercentage`	️	tetapkan persentase kartu oleh uuid

Bekerja dengan kartu sebagai peran user

Metode	Status	Keterangan
`getById`	?	dapatkan kartu melalui uuid

Jika Anda perlu mengekspor semua kartu, Anda dapat menggunakan CardsFetcher

Tingkat Kartu

Bekerja dengan level kartu sebagai peran admin

Metode	Status	Keterangan
`list`	?	dapatkan daftar level kartu
`add`	?	tambahkan level kartu baru
`delete`	?	hapus tingkat kartu
`update`	️	perbarui tingkat kartu

Transaksi

Bekerja dengan transaksi sebagai peran admin .

Layanan transaksi berisi metode, metode daftar bekerja dengan pagination

Metode	Keterangan
`list`	dapatkan daftar transaksi untuk semua kartu dengan pagination
`count`	menghitung transaksi
`getByCardNumber`	dapatkan daftar transaksi untuk nomor kartu saat ini
`processAccrualTransactionByCardNumber`	memproses transaksi akrual
`processPaymentTransactionByCardNumber`	memproses transaksi pembayaran

jika Anda ingin membaca semua transaksi tanpa pagination, Anda dapat bekerja dengan TransactionsFetcher Semua metode pengambil mengembalikan generator, di bawah kap pengambil menggunakan pagination.

Metode	Keterangan
`list`	dapatkan daftar transaksi untuk semua kartu
`listByCardNumber`	daftar semua transaksi untuk kartu saat ini

Bekerja dengan transaksi sebagai peran user

Metode	Status	Keterangan
`getByCardId`	?	dapatkan daftar transaksi untuk kartu saat ini

Kontak

Bekerja dengan kontak sebagai peran admin

Metode	Status	Keterangan
`list`	✅	dapatkan daftar kontak
`getById`	✅	dapatkan kontak melalui id
`add`	✅	menambahkan kontak baru
`update`	️	perbarui kontak
`delete`	️	hapus kontak
`count`	✅	menghitung kontak
`startAuthByPhone`	️	mulai upaya autentikasi melalui telepon
`finishAuth`	️	selesaikan upaya autentikasi

Bekerja dengan kontak sebagai peran user

Metode	Status	Keterangan
`getById`	?	dapatkan kontak melalui id
`startAuthByPhone`	?	mulai upaya autentikasi melalui telepon
`finishAuth`	?	selesaikan upaya autentikasi

Jika Anda perlu mengekspor semua kontak, Anda dapat menggunakan ContactsFetcher

Perusahaan

Bekerja dengan perusahaan sebagai peran admin

Metode	Status	Keterangan
`current`		dapatkan perusahaan saat ini
`add`	️	tambahkan perusahaan
`update`	️	perbarui perusahaan
`delete`	️	hapus perusahaan

Bekerja dengan perusahaan sebagai peran user

Metode	Status	Keterangan
`current`	?	dapatkan perusahaan saat ini

Jurnal Aplikasi

Bekerja dengan jurnal aplikasi sebagai peran admin

Metode	Status	Keterangan
`list`	?	dapatkan daftar item jurnal aplikasi dengan navigasi halaman
`getById`	?	dapatkan item jurnal aplikasi berdasarkan id

Titik Sentuh

Bekerja dengan titik sentuh sebagai peran admin

Metode	Status	Keterangan
`list`	?	dapatkan daftar titik kontak dengan navigasi halaman
`getById`	?	dapatkan item titik sentuh berdasarkan id
`add`	?	tambahkan titik sentuh baru
`update`	️	perbarui titik sentuh
`delete`		hapus titik sentuh

Penggunaan Dasar

Utilitas baris perintah

Utilitas baris perintah untuk bekerja melalui REST-API

php bin/console

cards:export Ekspor kartu loyalitas ke file csv
transactions:bulk-transaction Transaksi massal ke semua kartu aktif: akrual atau pembayaran
transactions:load-from-file Memproses transaksi dari file csv
transactions:export Ekspor transaksi ke file csv