loyalty php sdk

Loyalität-php-sdk

loyalty php sdk ist ein Tool für die Arbeit mit dem REST-API Bitrix24 Application Loyalty Program und Bonuskarten für Bitrix24 CRM

• Treue-App fügt Bonuskarte für Bitrix24-Kundenprofil im CRM hinzu
• Die Treue-App unterstützt Transaktionen für Zahlungs- und Abgrenzungsvorgänge
• Prozentsatz des Rabatts im Geschäft
• Operationen mit Karten: Erstellen, Lesen, Löschen, Blockieren

Dokumentation

• REST-API-Dokumentation

Installation

Über Komponist

$ composer require b24io/loyalty-php-sdk

Versionen

Loyalität-php-sdk Version	Supportstatus	bauen Status	REST-API Version	PHP Versionen
v4.x	? aktiv		2	8.2 , 8.3
v3.x	? Nur Bugfix		2	7.4
v2	? Lebensende ☠️		1	7.4
v1	? Lebensende ☠️		1	7.4

Anforderungen

loyalty php sdk funktioniert mit PHP 8.2 oder höher und benötigt ext-json und ext-curl -Unterstützung

Authentifizierung mit Administrator- und Benutzerrollen

SDK kann mit zwei Rollen arbeiten:

• admin – kann mit allen Karten in seinem Konto und seiner Treueanwendungsinstanz arbeiten
• user - kann nur mit seiner eigenen Karte arbeiten

Wir arbeiten mit vielen Konten, jedes Konto hat einen CLIENT_API_KEY Wenn Sie in der Administratorrolle arbeiten möchten, müssen Sie ADMIN_API_KEY zum Signieren von Abfragen verwenden. Wenn Sie mit der Client-Rolle in JS arbeiten möchten, müssen Sie CLIENT_API_KEY und CARD_UUID als Benutzer-API-Schlüssel verwenden.

Über die REST-API verfügbare Domänenentitäten

Legende

• ✅ – verfügbar über die Rest-API und implementiert im PHP-SDK
• ? — Verfügbar über die Rest-API und nicht im PHP-SDK implementiert
• – nicht in Rest-API implementiert

Karten

Arbeiten Sie mit der Karte als admin

Verfahren	Status	Beschreibung
list	✅	Kartenliste mit Seitennavigation abrufen
getById	✅	Karte per UUID abrufen
count	✅️	Karten zählen
delete		Karte per UUID löschen
add	✅️	Neue Karte hinzufügen
block	️	Karte per UUID blockieren
unblock	️	Karte per UUID entsperren
setLevel	️	Kartenebene per UUID festlegen
setPercentage	️	Kartenprozentsatz nach UUID festlegen

Arbeiten Sie mit der Karte als user

Verfahren	Status	Beschreibung
getById	?	Karte per UUID abrufen

Wenn Sie alle Karten exportieren müssen, können Sie CardsFetcher verwenden

Kartenebenen

Arbeiten Sie mit Kartenebenen als admin

Verfahren	Status	Beschreibung
list	?	Liste der Kartenebenen abrufen
add	?	Neue Kartenebene hinzufügen
delete	?	Kartenebene löschen
update	️	Kartenebene aktualisieren

Transaktionen

Arbeiten Sie als admin mit Transaktionen.

Der Transaktionsdienst enthält Methoden, Listenmethoden und Paginierung

Verfahren	Beschreibung
list	Transaktionsliste für alle Karten mit Paginierung abrufen
count	Transaktionen zählen
getByCardNumber	Transaktionsliste für die aktuelle Kartennummer abrufen
processAccrualTransactionByCardNumber	Abgrenzungstransaktion verarbeiten
processPaymentTransactionByCardNumber	Zahlungstransaktion abwickeln

Wenn Sie alle Transaktionen ohne Paginierung lesen möchten, können Sie mit TransactionsFetcher arbeiten. Alle Fetcher-Methoden geben den Generator zurück. Unter der Haube verwendet Fetcher die Paginierung.

Verfahren	Beschreibung
list	Transaktionsliste für alle Karten abrufen
listByCardNumber	Listen Sie alle Transaktionen für die aktuelle Karte auf

Arbeiten Sie mit Transaktionen als user

Verfahren	Status	Beschreibung
getByCardId	?	Transaktionsliste für die aktuelle Karte abrufen

Kontakte

Arbeiten Sie mit Kontakten als admin

Verfahren	Status	Beschreibung
list	✅	Kontaktliste abrufen
getById	✅	Nehmen Sie Kontakt per ID auf
add	✅	Neuen Kontakt hinzufügen
update	️	Kontakt aktualisieren
delete	️	Kontakt löschen
count	✅	Kontakte zählen
startAuthByPhone	️	Authentifizierungsversuch per Telefon starten
finishAuth	️	Beenden Sie den Authentifizierungsversuch

Arbeiten Sie mit Kontakten als user

Verfahren	Status	Beschreibung
getById	?	Nehmen Sie Kontakt per ID auf
startAuthByPhone	?	Authentifizierungsversuch per Telefon starten
finishAuth	?	Beenden Sie den Authentifizierungsversuch

Wenn Sie alle Kontakte exportieren müssen, können Sie ContactsFetcher verwenden

Unternehmen

Arbeiten Sie als admin mit dem Unternehmen zusammen

Verfahren	Status	Beschreibung
current		Holen Sie sich aktuelle Firma
add	️	Firma hinzufügen
update	️	Update-Firma
delete	️	Firma löschen

Arbeiten Sie mit dem Unternehmen als user

Verfahren	Status	Beschreibung
current	?	Holen Sie sich aktuelle Firma

Bewerbungsjournal

Arbeiten Sie mit dem Bewerbungsjournal als admin

Verfahren	Status	Beschreibung
list	?	Rufen Sie die Liste der Bewerbungsjournalelemente mit Seitennavigation ab
getById	?	Bewerbungsjournalelement anhand der ID abrufen

TouchPoints

Arbeiten Sie mit Touchpoints als admin

Verfahren	Status	Beschreibung
list	?	Erhalten Sie eine Liste der Berührungspunkte mit Seitennavigation
getById	?	Touchpoint-Element anhand der ID abrufen
add	?	Neuen Berührungspunkt hinzufügen
update	️	Berührungspunkt aktualisieren
delete		Berührungspunkt löschen

Grundlegende Verwendung

Befehlszeilen-Dienstprogramme

Befehlszeilen-Dienstprogramme für die Arbeit über REST-API

php bin/console

• cards:export Kundenkarten in eine CSV-Datei exportieren
• transactions:bulk-transaction Massentransaktion auf alle aktiven Karten: Abgrenzung oder Zahlung
• transactions:load-from-file Transaktionen aus der CSV-Datei verarbeiten
• transactions:export Transaktionen in eine CSV-Datei exportieren

Einreichen von Fehlern und Funktionsanfragen

Fehler und Funktionsanfragen werden auf GitHub verfolgt

Entwicklung

Testen

Führen Sie das statische Analysetool aus

make phpstan

Unterstützung

• [email protected]

Sicherheit

Wenn Sie sicherheitsrelevante Probleme feststellen, kontaktieren Sie uns bitte unter [email protected]

Lizenz

Die MIT-Lizenz (MIT). Weitere Informationen finden Sie in der Lizenzdatei.